Adapter Framework for Equipment Monitoring and Control
The Lightweight Equipment Adapter Framework (LEAF) implements an Adapter Architecture designed to monitor and control various equipment types (e.g., bioreactors). The core principle of LEAF is to reduce the barrier to entry as much as possible to develop and deploy adapters for new equipment. The EquipmentAdapters are the functional equipment monitors composed of the rest of the modules (ProcessModules, PhaseModules, etc.) that perform specific tasks such as event monitoring, data processing, and output transmission.
Quick Start
# Install LEAF
pip install leaf-framework
# Run with desktop GUI (auto-opens browser)
leaf
LEAF automatically shows a desktop control panel on desktop systems, making it easy to see if the application is running and where to access it.
Password for the web interface
The web interface is open by default. When it runs where others can reach it (a Kubernetes pod with an ingress, a shared server), set LEAF_UI_PASSWORD: every page then asks for that password once, on a login form password managers can fill, and keeps the browser logged in for 30 days. Changing the password logs every browser out. It sends the password over the wire, so serve the interface over HTTPS.
Updating
LEAF checks PyPI for a newer release one hour after it starts, and weekly from then on -- never at startup, so a restart simply re-arms the one-hour delay. When a newer version exists, an update badge appears next to the version number in the web interface header; clicking it offers to install the update and restart LEAF.
To check without waiting for the schedule, click the version number in the header. The result appears as a banner: green when this install is current, amber when a newer release exists, red when PyPI could not be reached.
Set LEAF_DISABLE_UPDATE_CHECK=1 to switch the check off entirely. Set LEAF_DISABLE_ADAPTER_INSTALL=1 to stop the web interface from installing or uninstalling adapters, e.g. on a shared deployment whose adapters come from its image. Installs running from a source checkout are told about the new version but never overwritten -- update those with git pull. To update by hand:
pip install --upgrade leaf-framework
Documentation
The complete documentation can be found here.
Metadata
Release files for leaf-framework 0.11.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| leaf_framework-0.11.1.tar.gz | 417.6 kB | Without provenance | Details for leaf_framework-0.11.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| leaf_framework-0.11.1-py3-none-any.whl | Python 3 | none | any | Details for leaf_framework-0.11.1-py3-none-any.whl |
Total release size: 882.0 kB
Release files / leaf_framework-0.11.1.tar.gz
| Download URL | leaf_framework-0.11.1.tar.gz |
|---|---|
| Size | 417.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d4feed702df9328d2c4df4781b27ec577153b5d8473f4197e4c4335bdbed0a7
|
|
BLAKE2b-256 checksum How to use checksums |
e45c5b541f1b81a84d9a22ef2a3d079636091841b7e2cf2dd7934311b5a5ee2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / leaf_framework-0.11.1-py3-none-any.whl
| Download URL | leaf_framework-0.11.1-py3-none-any.whl |
|---|---|
| Size | 464.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
08de86cef0a229eb689862d99d0ff5366749bc75ab0d8349698bd5c304693a7b
|
|
BLAKE2b-256 checksum How to use checksums |
c27408653609448805a8bb06ef2e6cd2f872b7e4c350c3903c6be22cc2014817
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Security for leaf-framework 0.11.1
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.