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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file queenbee-2.0.1.tar.gz.
File metadata
- Download URL: queenbee-2.0.1.tar.gz
- Upload date:
- Size: 51.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7ccd60f46e349029c2658336f84e29ebe244827cb3c51e0c3aedf36829e1b614
|
|
| MD5 |
254be8d12fee85cb5215fd8d531c9db3
|
|
| BLAKE2b-256 |
40d3f4d00630bd8c7284eddc9daf50525c73255d189937170e64fccbd7938dbe
|
File details
Details for the file queenbee-2.0.1-py3-none-any.whl.
File metadata
- Download URL: queenbee-2.0.1-py3-none-any.whl
- Upload date:
- Size: 84.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9fe7b52bb97338484965f1c4b9a00035887455aa917a29d1650b9e3423d7028e
|
|
| MD5 |
7ff7454de1e77d8d501a872377a4a524
|
|
| BLAKE2b-256 |
252ebe49a64b95e9da7e4e19f278dab91e16f3063955a78f221d067766681818
|
