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.
> pip install queenbee
or if you want to use the CLI
> pip install queenbee[cli]
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 |
Clone this repo locally
git clone git@github.com:ladybug-tools/queenbeeor
git clone https://github.com/ladybug-tools/queenbeeInstall dependencies using poetry:
cd queenbeepoetry shellpoetry install --extras cli
Run Tests:
python -m pytest tests/Generate Documentation:
sphinx-apidoc-f-e-d4-o ./docs/modules ./queenbeesphinx-build-bhtml ./docs ./docs/_build
Preview Documentation:
python -m http.server --directory ./docs/_build/Now you can see the documentation preview at http://localhost:8000