Update documentation and start documenting 2.x client methods.

Author: paul121

README.md

@@ -18,23 +18,10 @@ For more information on farmOS, visit [farmOS.org](https://farmOS.org).
      - [OAuth Password Credentials](#oauth-password-credentials-most-common)
      - [OAuth Authorization Flow](#oauth-authorization-flow-advanced)
      - [Saving OAuth Tokens](#saving-oauth-tokens)
-  - [Server Info](#server-info)   
-  - [Logs](#logs)
-    - [`.get()`](#get)
-    - [`.send()`](#send)
-    - [`.delete()`](#delete)
-  - [Assets](#assets)
-    - [`.get()`](#get-1)
-    - [`.send()`](#send-1)
-    - [`.delete()`](#delete-1)
-  - [Areas](#areas)
-    - [`.get()`](#get-2)
-    - [`.send()`](#send-2)
-    - [`.delete()`](#delete-2)
-  - [Taxonomy Terms](#taxonomy-terms)
-    - [`.get()`](#get-3)
-    - [`.send()`](#send-3)
-    - [`.delete()`](#delete-3)
+  - [Server Info](#server-info)
+  - [Client methods](#client-methods)  
+    - [farmOS 1.x](docs/client_1x.md)
+    - [farmOS 2.x](docs/client_2x.md)
   - [Logging](#logging)
 
 
@@ -68,7 +55,8 @@ password = "password"
 farm_client = farmOS(
     hostname=hostname,
     client_id = "farm", # Optional. The default oauth client_id "farm" is enabled on all farmOS servers.
-    scope="user_access" # Optional. The default scope is "user_access". Only needed if authorizing with a differnt scope.
+    scope="user_access", # Optional. The default scope is "user_access". Only needed if authorizing with a different scope.
+    version=1 # Optional. The major version of the farmOS server, 1 or 2. Defaults to 1.
 )
 
 # Authorize the client, save the token.
@@ -172,270 +160,17 @@ info = farm_client.info()
 }
 ```
 
-### Logs
 
+### Client methods
 
-A log is any type of event that occurs on the farm, from a planting to a harvest
-to just a general observation.
+farmOS.py can connect to farmOS servers running version 1.x or 2.x. The version should be specified when instantiating
+the farmOS client, see [Authentication](#authentication).
 
-Methods for getting, sending and deleting logs are namespaced on the `farm.log`
-property.
+Because of [API changes](https://2x.farmos.org/development/api/changes/) in farmOS 2.x, the client provides different
+methods depending on the server version:
 
-#### `.get()`
-
-```python
-# Get all logs
-logs = farm_client.log.get()['list']
-
-# Get harvest logs
-filters = {
-    'type': 'farm_harvest'
-}
-
-harvests = farm_client.log.get(filters=filters)['list']
-
-# Get log number 37
-log = farm_client.log.get(37)
-```
-
-The four default log types are:
-
-- `farm_activity`
-- `farm_harvest`
-- `farm_input`
-- `farm_observation`
-
-Other log types may be provided by add-on modules in farmOS.
-
-#### `.send()`
-
-Send can be used to create a new log, or if the `id` property is included, to
-update an existing log:
-
-```python
-
-# Create observation log
-observation_log = {
-  "name": "My Great Planting",
-  "type": "farm_observation",
-  "done": 0,
-  "notes": "Some notes"    
-}
-log = farm_client.log.send(log)
-
-# Mark log 35 as done
-done = {
-    'id': 45,
-    'done': 1
-}
-log = farm_client.log.send(done)
-```
-
-#### `.delete()`
-
-```python
-farm_client.log.delete(123)
-```
-
-### Assets
-
-Assets are any piece of property or durable good that belongs to the farm, such
-as a piece of equipment, a specific crop, or an animal.
-
-Methods for getting, sending and deleting assets are namespaced on the
-`farm.asset` property.
-
-#### `.get()`
-
-```python
-
-# Get all assets
-assets = farm_client.asset.get()['list']
-
-# Get all animal assets
-filters = {
-  'type':'animal'
-}
-animals = farm_client.asset.get(filters=filters)['list']
-
-# Get asset ID 45
-asset = farm_client.asset.get(45)
-```
-
-Some common asset types include:
-
-- `animal`
-- `equipment`
-- `planting`
-
-Other asset types may be provided by add-on modules in farmOS.
-
-#### `.send()`
-
-Send can be used to create a new asset, or if the `id` property is included, to update an existing asset:
-
-```python
-
-planting_asset = {
-  "name": "My Great Planting",
-  "type": "planting",
-  "crop": [
-    {"id": 8} # Crop term id
-  ]
-}
-
-asset = farm_client.asset.send(planting_asset)
-```
-
-#### `.delete()`
-
-```python
-farm_client.asset.delete(123)
-```
-
-### Areas
-
-An area is any well defined location that has been mapped in farmOS, such as a field, greenhouse, building, etc.
-
-Here's an example of what an area looks like as a Python dict:
-
-```python
-{
-  'tid': '22',
-  'name': 'F1',
-  'description': '',
-  'area_type': 'greenhouse',
-  'geofield': [
-    {
-      'geom': 'POLYGON ((-75.53640916943549 42.54421203378203, -75.53607389330863 42.54421796218091, -75.53607121109961 42.54415472589722, -75.53640648722647 42.54414682135726, -75.53640916943549 42.54421203378203))',
-    }
-  ],
-  'vocabulary': {
-    'id': '2',
-    'resource': 'taxonomy_vocabulary'
-  },
-  'parent': [
-    {
-      'id': 11,
-      'resource': 'taxonomy_term'
-    }
-  ],
-  'weight': '0',
-}
-```
-
-Methods for getting, sending and deleting areas are namespaced on the `farm.area` property.
-
-#### `.get()`
-
-```python
-
-# Get all areas
-areas = farm_client.area.get()['list']
-
-# Get field areas
-filters = {
-  'area_type':'field'
-}
-fields = farm_client.area.get(filters=filters)['list']
-
-# Get area with tid 37
-area = farm_client.area.get(37)
-```
-
-__NOTE:__ Areas use a `tid` property, unlike logs and assets which have an `id`. This stands for taxonomy ID. In the future this may be changed to make it more consistent with the other entities.
-
-Some common area types include:
-
-- `field`
-- `building`
-- `property`
-- `water`
-- `other`
-
-Other area types may be provided by add-on modules in farmOS.
-
-#### `.send()`
-
-Send can be used to create a new area, or if the `tid` property is included, to update an existing area:
-
-```python
-
-
-
-```
-
-#### `.delete()`
-
-```python
-farm_client.area.delete(123)
-```
-
-### Taxonomy Terms
-
-farmOS allows farmers to build vocabularies of terms for various categorization
-purposes. These are referred to as "taxonomies" in farmOS (and Drupal), although
-"vocabulary" is sometimes used interchangeably.
-
-Some things that are represented as taxonomy terms include quantity units,
-crops/varieties, animal species/breeds, input materials, and log categories.
-See "Endpoints" above for specific API endpoints URLs.
-
-A very basic taxonomy term JSON structure looks like this:
-
-```json
-{
-  "tid": "3",
-  "name": "Cabbage",
-  "description": "",
-  "vocabulary": {
-    "id": "7",
-    "resource": "taxonomy_vocabulary",
-  },
-  "parent": [
-    {
-      "id": "10",
-      "resource": "taxonomy_term",
-    },
-  ],
-  "weight": "5",
-}
-```
-
-The `tid` is the unique ID of the term (database primary key). When creating a
-new term, the only required fields are `name` and `vocabulary`. The vocabulary
-is an ID that corresponds to the specific vocabulary the term will be a part of
-(eg: quantity units, crops/varieties, log categories, etc). The fields `parent`
-and `weight` control term hierarchy and ordering (a heavier `weight` will sort
-it lower in the list).
-
-#### `.get()`
-
-```python
-
-# Get all terms
-terms = farm_client.term.get()['list']
-
-# Get all terms from farm_crops vocabulary
-crops = farm_client.term.get('farm_crops')['list']
-
-# Get term ID 67
-term = farm_client.term.get(67)
-```
-
-#### `.send()`
-
-Send can be used to create a new taxonomy term, or if the `tid` property is included in the term object, to update an existing area:
-
-```python
-
-```
-
-#### `.delete()`
-
-```python
-farm_client.term.delete(56)
-```
+- [1.x methods](docs/client_1x.md)
+- [2.x methods](docs/client_2x.md)
 
 ### Logging