A Python library for interacting with farmOS over API.
Project description
farmOS.py
farmOS.py is a Python library for interacting with farmOS over API.
For more information on farmOS, visit farmOS.org.
USAGE
import farmOS
hostname = 'myfarm.farmos.net'
username = 'My Name'
password = 'mYPa$$w0rd'
farm = farmOS.farmOS(hostname, username, password)
success = farm.authenticate()
# Get farm info
info = farm.info()
# Get all logs
logs = farm.log.get()
# Get harvest logs
harvests = farm.log.get({
'type':'farm_harvest'
})
# Get log number 37
log = farm.log.get(37)
# Get all assets
assets = farm.asset.get()
# Get all animal assets
animals = farm.log.get({
'type':'animal'
})
# Get all areas
areas = farm.area.get()
# Get field areas
fields = farm.area.get({
'area_type':'field'
})
# Get all terms
terms = farm.term.get()
# Get all terms from farm_crops vocabulary
crops = farm.term.get('farm_crops')
TESTING
Configure credentials for the farmOS instance used to test in
tests/test_credentials.py
Automated tests are run with pytest
python setup.py test
MAINTAINERS
- Paul Weidner (paul121) - https://github.com/paul121
- Michael Stenta (m.stenta) - https://github.com/mstenta
This project has been sponsored by:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
farmOS-0.1.2.tar.gz
(11.7 kB
view details)
Built Distribution
farmOS-0.1.2-py3-none-any.whl
(25.1 kB
view details)
File details
Details for the file farmOS-0.1.2.tar.gz
.
File metadata
- Download URL: farmOS-0.1.2.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 886222d4b8c537fc54e5d91f35e9df3a2bbe745c61954feff5c0bdf18ba891aa |
|
MD5 | ba7106ef5bea8f5c307623aa1352ef38 |
|
BLAKE2b-256 | 7098584b9fcf5fdb0861b8c66e6ae5af416ea58880b56c1a46ffd7569edc1e25 |
File details
Details for the file farmOS-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: farmOS-0.1.2-py3-none-any.whl
- Upload date:
- Size: 25.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d5bf488fd1b3f93a8242919a653a16ff5e39001085af96650aa3141112870c0 |
|
MD5 | 61fab3ecb2dcb5bc7a969815a1354808 |
|
BLAKE2b-256 | 2f3d683b3ab9263874c98875243754578d1e82b5fffa0e51ba3c93edad8e86b0 |