queenbee 1.24.6

Queenbee is a workflow language and a package manager for creating DAG workflows which empowers all workflow libraries in Ladybug Tools!

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 raw OpenAPI definitions.

Local Development

1. Clone this repo locally

   git clone [e-mail]:ladybug-tools/queenbee
   

   or

   git clone https://github.com/ladybug-tools/queenbee
   

2. Install dependencies:

   cd queenbee
   pip install -r dev-requirements.txt
   pip install -r requirements.txt
   

3. Run Tests:

   python -m pytest tests/
   

4. Generate Documentation:

   sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee
   sphinx-build -b html ./docs ./docs/_build
   

5. Preview Documentation:

   python -m http.server --directory ./docs/_build/
   

   Now you can see the documentation preview at http://localhost:8000