Skip to main content

A Python library for interacting with farmOS over API.

Project description

farmOS.py

Licence Release Last commit Twitter Chat

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

This project has been sponsored by:

Project details


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.1.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

farmOS-0.1.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file farmOS-0.1.1.tar.gz.

File metadata

  • Download URL: farmOS-0.1.1.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.5

File hashes

Hashes for farmOS-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c98b17d5668ecedb6f3275c2dfed03aadfad35cf2717e5998e6d61fd64bcfdbf
MD5 49c611902d7f4a255c1c15522fd45210
BLAKE2b-256 32016abc065d2021a290ece14350a41a942c94270c12875177b544c5af209e1e

See more details on using hashes here.

File details

Details for the file farmOS-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: farmOS-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.5

File hashes

Hashes for farmOS-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d538c81672d857602ea975f8c29c63c0b14aab53df04d98e8dcea66c3118b362
MD5 9806dc108336e4637dbb39b1b17749fe
BLAKE2b-256 bc75c2b0cc927b9fd10db460a071af12fcb88ba8ed5f76a5a3de724d951fd55e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page