| Name | queenbee JSON |
| Version |
1.28.1
JSON |
| download |
| home_page | https://github.com/pollination/queenbee |
| Summary | Queenbee is a workflow language and a package manager for creating DAG workflows which empowers all workflow libraries in Ladybug Tools! |
| upload_time | 2024-10-22 17:00:32 |
| maintainer | None |
| docs_url | None |
| author | Ladybug Tools |
| requires_python | <4.0,>=3.7 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Queenbee :crown:
Queenbee is a workflow language for describing workflows! The workflow Schema
is inspired by [Argo Workflow](https://argoproj.github.io/docs/argo/readme.html) and
borrows a number of terms and expressions from
[Apache Airflow](http://airflow.apache.org/) and [Ansible](https://docs.ansible.com/).
Queenbee populates and validates the workflows but does not run them! For running the
workflows see
[`ladybug-tools/queenbee-luigi`](https://github.com/ladybug-tools/queenbee-luigi)
which converts Queenbee workflows to executable
[Luigi](https://luigi.readthedocs.io/en/stable/) pipelines.
You can find more workflow samples in
[honeybee-radiance-workflow](https://github.com/ladybug-tools/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](https://pollination.github.io/queenbee/).
You can also access the [Schema
Documentation](https://pollination.github.io/queenbee/schemas/index.html) and
OpenAPI documentation for:
| Object | Redoc | OpenAPI JSON |
| ------ | --------------------- | ------------------- |
| Plugin | [redoc][plugin-redoc] | [json][plugin-json] |
| Recipe | [redoc][recipe-redoc] | [json][recipe-json] |
| Job | [redoc][job-redoc] | [json][job-json] |
[plugin-json]: https://pollination.github.io/queenbee/_static/schemas/plugin-openapi.json
[plugin-redoc]: https://pollination.github.io/queenbee/_static/redoc-plugin.html#tag/plugin_model
[recipe-json]: https://pollination.github.io/queenbee/_static/schemas/recipe-openapi.json
[recipe-redoc]: https://pollination.github.io/queenbee/_static/redoc-recipe.html#tag/recipe_model
[job-json]: https://pollination.github.io/queenbee/_static/schemas/job-openapi.json
[job-redoc]: https://pollination.github.io/queenbee/_static/redoc-job.html#tag/job_model
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/queenbee
```
or
```console
git clone https://github.com/ladybug-tools/queenbee
```
2. Install dependencies using [poetry](https://python-poetry.org/):
```console
cd queenbee
poetry shell
poetry install --extras cli
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```python
sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee
sphinx-build -b html ./docs ./docs/_build
```
5. Preview Documentation:
```console
python -m http.server --directory ./docs/_build/
```
Now you can see the documentation preview at http://localhost:8000
Raw data
{
"_id": null,
"home_page": "https://github.com/pollination/queenbee",
"name": "queenbee",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/b3/b1/73eef938db734963dc7670a745cf309616e745b32e899a70fc37ecceea62/queenbee-1.28.1.tar.gz",
"platform": null,
"description": "# Queenbee :crown:\n\nQueenbee is a workflow language for describing workflows! The workflow Schema\nis inspired by [Argo Workflow](https://argoproj.github.io/docs/argo/readme.html) and\nborrows a number of terms and expressions from\n[Apache Airflow](http://airflow.apache.org/) and [Ansible](https://docs.ansible.com/).\n\nQueenbee populates and validates the workflows but does not run them! For running the\nworkflows see\n[`ladybug-tools/queenbee-luigi`](https://github.com/ladybug-tools/queenbee-luigi)\nwhich converts Queenbee workflows to executable\n[Luigi](https://luigi.readthedocs.io/en/stable/) pipelines.\n\nYou can find more workflow samples in\n[honeybee-radiance-workflow](https://github.com/ladybug-tools/honeybee-radiance-workflow)\nrepository.\n\n## Installation\n\n```\n> pip install queenbee\n```\n\nor if you want to use the CLI\n\n```\n> pip install queenbee[cli]\n```\n\n## Documentation\n\nYou can access the full docs for this package and its CLI\n[here](https://pollination.github.io/queenbee/).\n\nYou can also access the [Schema\nDocumentation](https://pollination.github.io/queenbee/schemas/index.html) and\nOpenAPI documentation for:\n\n| Object | Redoc | OpenAPI JSON |\n| ------ | --------------------- | ------------------- |\n| Plugin | [redoc][plugin-redoc] | [json][plugin-json] |\n| Recipe | [redoc][recipe-redoc] | [json][recipe-json] |\n| Job | [redoc][job-redoc] | [json][job-json] |\n\n[plugin-json]: https://pollination.github.io/queenbee/_static/schemas/plugin-openapi.json\n[plugin-redoc]: https://pollination.github.io/queenbee/_static/redoc-plugin.html#tag/plugin_model\n[recipe-json]: https://pollination.github.io/queenbee/_static/schemas/recipe-openapi.json\n[recipe-redoc]: https://pollination.github.io/queenbee/_static/redoc-recipe.html#tag/recipe_model\n[job-json]: https://pollination.github.io/queenbee/_static/schemas/job-openapi.json\n[job-redoc]: https://pollination.github.io/queenbee/_static/redoc-job.html#tag/job_model\n\n## Local Development\n\n1. Clone this repo locally\n\n ```console\n git clone git@github.com:ladybug-tools/queenbee\n ```\n\n or\n\n ```console\n git clone https://github.com/ladybug-tools/queenbee\n ```\n\n2. Install dependencies using [poetry](https://python-poetry.org/):\n\n ```console\n cd queenbee\n poetry shell\n poetry install --extras cli\n ```\n\n3. Run Tests:\n\n ```console\n python -m pytest tests/\n ```\n\n4. Generate Documentation:\n\n ```python\n sphinx-apidoc -f -e -d 4 -o ./docs/modules ./queenbee\n sphinx-build -b html ./docs ./docs/_build\n ```\n\n5. Preview Documentation:\n\n ```console\n python -m http.server --directory ./docs/_build/\n ```\n\n Now you can see the documentation preview at http://localhost:8000\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Queenbee is a workflow language and a package manager for creating DAG workflows which empowers all workflow libraries in Ladybug Tools!",
"version": "1.28.1",
"project_urls": {
"Documentation": "https://pollination.github.io/queenbee/",
"Homepage": "https://github.com/pollination/queenbee",
"Repository": "https://github.com/pollination/queenbee"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31ac8fcdf6217062da4aacf0c18de549b56fb311d6a517d4427f3a1eb6a398a4",
"md5": "95e677343ea7419e4ccb9eb1b1829c3b",
"sha256": "0a3618947847488e9f40caf9f14136a751d014b7e9287208a93891f938e92ff5"
},
"downloads": -1,
"filename": "queenbee-1.28.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95e677343ea7419e4ccb9eb1b1829c3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 83704,
"upload_time": "2024-10-22T17:00:30",
"upload_time_iso_8601": "2024-10-22T17:00:30.445272Z",
"url": "https://files.pythonhosted.org/packages/31/ac/8fcdf6217062da4aacf0c18de549b56fb311d6a517d4427f3a1eb6a398a4/queenbee-1.28.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3b173eef938db734963dc7670a745cf309616e745b32e899a70fc37ecceea62",
"md5": "2b7a77a6db9b4a5a1301c91fbdf84d69",
"sha256": "0f12ac7a44270332087f8d975e0bf4e1ff513db6828fc4798fe7b9c93b841085"
},
"downloads": -1,
"filename": "queenbee-1.28.1.tar.gz",
"has_sig": false,
"md5_digest": "2b7a77a6db9b4a5a1301c91fbdf84d69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 52865,
"upload_time": "2024-10-22T17:00:32",
"upload_time_iso_8601": "2024-10-22T17:00:32.468303Z",
"url": "https://files.pythonhosted.org/packages/b3/b1/73eef938db734963dc7670a745cf309616e745b32e899a70fc37ecceea62/queenbee-1.28.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 17:00:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pollination",
"github_project": "queenbee",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "queenbee"
}
