Queenbee :crown:
Queenbee is a workflow language for describing workflows! The workflow Schema is inspired by Argo Workflow and borrows a number of terms and expressions from Apache Airflow and Ansible.
Queenbee populates and validates the workflows but does not run them! For running the
workflows see
ladybug-tools/queenbee-luigi
which converts Queenbee workflows to executable
Luigi pipelines.
You can find examples of run-able queenbee workflows in the lbt-recipes repository.
Installation
> pip install queenbee
or if you want to use the CLI
> pip install queenbee[cli]
Documentation
You can access the full docs for this package and its CLI here.
You can also access the Schema Documentation and OpenAPI documentation for:
| Object | Redoc | OpenAPI JSON |
|---|---|---|
| Plugin | redoc | json |
| Recipe | redoc | json |
| Job | redoc | json |
Local Development
-
Clone this repo locally
git clone git@github.com:ladybug-tools/queenbeeor
git clone https://github.com/ladybug-tools/queenbee -
Install dependencies using poetry:
cd queenbee poetry shell poetry install --extras cli
-
Run Tests:
python -m pytest tests/ -
Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee sphinx-build -b html ./docs ./docs/_build
-
Preview Documentation:
python -m http.server --directory ./docs/_build/Now you can see the documentation preview at http://localhost:8000
2 maintainers
Release files for queenbee 2.0.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 | |
|---|---|---|---|
| queenbee-2.0.1.tar.gz | 51.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| queenbee-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 136.0 kB
Release files / queenbee-2.0.1.tar.gz
| Download URL | queenbee-2.0.1.tar.gz |
|---|---|
| Size | 51.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ccd60f46e349029c2658336f84e29ebe244827cb3c51e0c3aedf36829e1b614
|
|
BLAKE2b-256 checksum How to use checksums |
40d3f4d00630bd8c7284eddc9daf50525c73255d189937170e64fccbd7938dbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
|
Release files / queenbee-2.0.1-py3-none-any.whl
| Download URL | queenbee-2.0.1-py3-none-any.whl |
|---|---|
| Size | 84.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9fe7b52bb97338484965f1c4b9a00035887455aa917a29d1650b9e3423d7028e
|
|
BLAKE2b-256 checksum How to use checksums |
252ebe49a64b95e9da7e4e19f278dab91e16f3063955a78f221d067766681818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
|
