Skip to main content

Farmware Tools

Tools for use by Farmware. Starting with FarmBot OS v6.4.2, this package is installed automatically and available for Farmware to import. See the sections below for other installation configurations.

Example

from farmware_tools import device
device.log('hello')

If the above code is run within a Farmware, FarmBot OS will send a hello log to the FarmBot Web App.

If the above code is run elsewhere, the output will be the command that would have been sent to FarmBot OS:

{'kind': 'send_message', 'args': {'message': 'hello', 'message_type': 'info'}}

Documentation

In addition to the Farmware development documentation, a list of available functions is available via the Python console:

from farmware_tools import app, device
help(app)
help(device)

Local installation (for local Farmware development)

pip install farmware-tools

user-level install: pip install --user farmware-tools

upgrade: pip install --user --upgrade farmware-tools

install a specific version: pip install --user farmware-tools==1.0.0

Specifying a version in a Farmware manifest

"farmware_tools_version": "v1.0.0"

By including this line in a Farmware manifest, FarmBot OS will automatically install the specified version and make it available to import from within the Farmware.

Metadata

Release files for farmware-tools 3.5.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for farmware-tools 3.5.6
File Size Uploaded Provenance
farmware_tools-3.5.6.tar.gz 14.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for farmware-tools 3.5.6
File Interpreter ABI Platform
farmware_tools-3.5.6-py3-none-any.whl Python 3 none any Details

Total release size: 31.9 kB

Release files / farmware_tools-3.5.6.tar.gz

Download URL farmware_tools-3.5.6.tar.gz
Size 14.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2db6a8ef9284657d5baf46faf9e7a108aa591e7e9d5b2aed5158b50e912987c3
BLAKE2b-256 checksum
How to use checksums
a0394b3e1a2e46d4e1c34339c9ae764dc75e318423627ceef15c16b4ef452169
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.0

Release files / farmware_tools-3.5.6-py3-none-any.whl

Download URL farmware_tools-3.5.6-py3-none-any.whl
Size 17.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2f9345671af048a5e890db77e5e59237ead0b2620138b040f87e15d6ee27bdb9
BLAKE2b-256 checksum
How to use checksums
a4c830a8893052381924b392b61b69781d3ecac4426d6d7c313e771fd8653202
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.8.0

Security for farmware-tools 3.5.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page