Queenbee is a workflow language and a package manager for creating DAG workflows which empowers all workflow libraries in Ladybug Tools!
Project description
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 more workflow samples in honeybee-radiance-workflow 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/queenbee
or
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
Project details
Release history Release notifications | RSS feed
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
Hashes for queenbee-1.28.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a3618947847488e9f40caf9f14136a751d014b7e9287208a93891f938e92ff5 |
|
MD5 | 95e677343ea7419e4ccb9eb1b1829c3b |
|
BLAKE2b-256 | 31ac8fcdf6217062da4aacf0c18de549b56fb311d6a517d4427f3a1eb6a398a4 |