# queenbee-pollination
queenbee-pollination extends [queenbee](https://github.com/pollination/queenbee) in order to interact with the [Pollination API](https://api.pollination.solutions).
## Installation
You can install this as a cli tool using the following command:
```console
pip install queenbee-pollination[cli]
```
## CLI QuickStart
### Authentication
The CLI tool will authenticate to the Pollination API in one of two ways:
#### Env Vars
Set the following environment variable as your API token before running commands `POLLINATION_TOKEN`.
Example for a bash shell:
```console
> export POLLINATION_TOKEN=<some-long-token-string>
> queenbee pollination project simulations list --project test-project --owner ladybug-tools
```
#### Queenbee Config
Re-use pollination auth set in your queenbee config. You can do so by using this command:
```console
> queenbee config auth add pollination YOUR_POLLINATION_API_KEY
```
### Push
You can push recipes and operators to the Pollination platform to share them with others or use them within simulations.
To push a recipe called `my-cool-recipe` to Pollination platform use:
```console
> queenbee pollination push recipe path/to/my-cool-recipe
```
You can push a recipe or operator too a specific pollination account by specifying the `--owner` flag. You can overwrite the resource's tag by using the `--tag` flag. Here is an example of pushing the `honeybee-radiance` operator to the `ladybug-tools` account and specifying a tag of `v0.0.0`.
```console
> queenbee pollination push operator ../garden/operators/honeybee-radiance --tag v0.0.0 --owner ladybug-tools
```
### Pull
You can pull recipes and operators from Pollination onto your machine by using the `pull` commands.
You can pull the latest version of `my-cool-recipe` from your pollination account by running:
```console
> queenbee pollination pull recipe my-cool-recipe
```
You can pull the `honeybee-radiance` operator from the `ladybug-tools` account and tag `v0.0.0` by running:
```console
> queenbee pollination pull operator honeybee-radiance --owner ladybug-tools --tag v0.0.0
```
**Note:** You can specify a folder to download the recipe/operator to by specifying the `--path` option flag.
### Projects
The project section of the CLI lets users upload files to a project and schedule simulations.
#### Folder
A user can upload or delete files in a project folder. To do so use the following commands:
##### Upload
You can upload artifacts to a project called `test-projectect` by using this command:
```console
> queenbee pollination project upload path/to/file/or/folder --project test-projectect
```
You can upload artifacts to a project belonging to another user or org:
```console
> queenbee pollination project upload path/to/file/or/folder --project test-projectect --owner ladybug-tools
```
##### Delete
You can delete all files in a project folder:
```console
> queenbee pollination project delete --project test-projectect
```
You can delete specific files in a project folder:
```console
> queenbee pollination project delete --project test-projectect --path some/subpath/to/a/file
```
#### Simulations
For a given project you can list, submit or download simulations.
##### List
```console
> queenbee pollination project simulation list -p test-projectect
```
##### Submit
You can submit a simulation without needing to specify any inputs (if the simulation does not require any!). The recipe to be used is specified in the following format `{owner}/{recipe-name}:{tag}`:
```console
> queenbee pollination project simulation submit chuck/first-test:0.0.1 -p demo
```
If you want to specify inputs you can point to an inputs file (`json` or `yaml`) which must represent a [Queenbee Workflow Argument](https://www.ladybug.tools/queenbee/_static/redoc-workflow.html#tag/arguments_model) object.
```console
> queenbee pollination project simulation submit ladybug-tools/daylight-factor:latest --project demo --inputs path/to/inputs.yml
```
##### Download
Once a simulation is complete you can download all inputs, outputs and logs to you machine. Here is an example downloading data from a simulation with an ID of `22c75263-c8ba-42d0-a1b8-bd3107eb6b51` from a project with name `demo` by using the following command:
```console
> queenbee pollination project simulation download --project demo --id 22c75263-c8ba-42d0-a1b8-bd3107eb6b51
```
Raw data
{
"_id": null,
"home_page": "https://github.com/pollination/queenbee-pollination",
"name": "queenbee-pollination",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/da/31/2c83b4c0c729bcd9a4fd722b5705b08095b4bb1f332a568fdf9603fe7ace/queenbee_pollination-0.7.10.tar.gz",
"platform": null,
"description": "# queenbee-pollination\n\nqueenbee-pollination extends [queenbee](https://github.com/pollination/queenbee) in order to interact with the [Pollination API](https://api.pollination.solutions).\n\n## Installation\n\nYou can install this as a cli tool using the following command:\n\n```console\npip install queenbee-pollination[cli]\n```\n\n## CLI QuickStart\n\n\n### Authentication\n\nThe CLI tool will authenticate to the Pollination API in one of two ways:\n\n#### Env Vars\n\nSet the following environment variable as your API token before running commands `POLLINATION_TOKEN`.\n\nExample for a bash shell:\n\n```console\n> export POLLINATION_TOKEN=<some-long-token-string>\n\n> queenbee pollination project simulations list --project test-project --owner ladybug-tools\n```\n\n#### Queenbee Config\n\nRe-use pollination auth set in your queenbee config. You can do so by using this command:\n\n```console\n> queenbee config auth add pollination YOUR_POLLINATION_API_KEY\n```\n\n### Push\n\nYou can push recipes and operators to the Pollination platform to share them with others or use them within simulations.\n\nTo push a recipe called `my-cool-recipe` to Pollination platform use:\n\n```console\n> queenbee pollination push recipe path/to/my-cool-recipe\n```\n\nYou can push a recipe or operator too a specific pollination account by specifying the `--owner` flag. You can overwrite the resource's tag by using the `--tag` flag. Here is an example of pushing the `honeybee-radiance` operator to the `ladybug-tools` account and specifying a tag of `v0.0.0`.\n\n```console\n> queenbee pollination push operator ../garden/operators/honeybee-radiance --tag v0.0.0 --owner ladybug-tools\n```\n\n### Pull\n\nYou can pull recipes and operators from Pollination onto your machine by using the `pull` commands.\n\nYou can pull the latest version of `my-cool-recipe` from your pollination account by running:\n\n```console\n> queenbee pollination pull recipe my-cool-recipe\n```\n\nYou can pull the `honeybee-radiance` operator from the `ladybug-tools` account and tag `v0.0.0` by running:\n\n```console\n> queenbee pollination pull operator honeybee-radiance --owner ladybug-tools --tag v0.0.0\n```\n\n**Note:** You can specify a folder to download the recipe/operator to by specifying the `--path` option flag.\n\n\n### Projects\n\nThe project section of the CLI lets users upload files to a project and schedule simulations.\n\n#### Folder\n\nA user can upload or delete files in a project folder. To do so use the following commands:\n\n##### Upload\n\nYou can upload artifacts to a project called `test-projectect` by using this command:\n\n```console\n> queenbee pollination project upload path/to/file/or/folder --project test-projectect\n```\n\nYou can upload artifacts to a project belonging to another user or org:\n\n```console\n> queenbee pollination project upload path/to/file/or/folder --project test-projectect --owner ladybug-tools\n```\n\n##### Delete\n\nYou can delete all files in a project folder:\n\n```console\n> queenbee pollination project delete --project test-projectect\n```\n\nYou can delete specific files in a project folder:\n\n```console\n> queenbee pollination project delete --project test-projectect --path some/subpath/to/a/file\n```\n\n\n#### Simulations\n\nFor a given project you can list, submit or download simulations.\n\n##### List\n\n```console\n> queenbee pollination project simulation list -p test-projectect\n```\n\n##### Submit\n\nYou can submit a simulation without needing to specify any inputs (if the simulation does not require any!). The recipe to be used is specified in the following format `{owner}/{recipe-name}:{tag}`:\n\n```console\n> queenbee pollination project simulation submit chuck/first-test:0.0.1 -p demo\n```\n\nIf you want to specify inputs you can point to an inputs file (`json` or `yaml`) which must represent a [Queenbee Workflow Argument](https://www.ladybug.tools/queenbee/_static/redoc-workflow.html#tag/arguments_model) object.\n\n```console\n> queenbee pollination project simulation submit ladybug-tools/daylight-factor:latest --project demo --inputs path/to/inputs.yml\n```\n\n##### Download\n\nOnce a simulation is complete you can download all inputs, outputs and logs to you machine. Here is an example downloading data from a simulation with an ID of `22c75263-c8ba-42d0-a1b8-bd3107eb6b51` from a project with name `demo` by using the following command:\n\n```console\n> queenbee pollination project simulation download --project demo --id 22c75263-c8ba-42d0-a1b8-bd3107eb6b51\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "queenbee-pollination extends queenbee to interact with the Pollination API",
"version": "0.7.10",
"project_urls": {
"Homepage": "https://github.com/pollination/queenbee-pollination"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "489c3a3368929078994354cd7a7e11974c463249586fc39e5e3688d377ed4f41",
"md5": "89c122c85858928626874da7485465fc",
"sha256": "5cf4fe62e897b13e2c13772be75b5765b2ac6eefc985763492a19167b0e10772"
},
"downloads": -1,
"filename": "queenbee_pollination-0.7.10-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "89c122c85858928626874da7485465fc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 10440,
"upload_time": "2024-10-22T19:38:53",
"upload_time_iso_8601": "2024-10-22T19:38:53.732261Z",
"url": "https://files.pythonhosted.org/packages/48/9c/3a3368929078994354cd7a7e11974c463249586fc39e5e3688d377ed4f41/queenbee_pollination-0.7.10-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da312c83b4c0c729bcd9a4fd722b5705b08095b4bb1f332a568fdf9603fe7ace",
"md5": "2db2878acd7caa3cd842d0447fbfcee1",
"sha256": "7b056eaf31ba1dd0d5bd15ed584c82a9e0bda9e0b576bfc674852cb0afe71d2d"
},
"downloads": -1,
"filename": "queenbee_pollination-0.7.10.tar.gz",
"has_sig": false,
"md5_digest": "2db2878acd7caa3cd842d0447fbfcee1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10809,
"upload_time": "2024-10-22T19:38:55",
"upload_time_iso_8601": "2024-10-22T19:38:55.332897Z",
"url": "https://files.pythonhosted.org/packages/da/31/2c83b4c0c729bcd9a4fd722b5705b08095b4bb1f332a568fdf9603fe7ace/queenbee_pollination-0.7.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 19:38:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pollination",
"github_project": "queenbee-pollination",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "queenbee-pollination"
}
JSON
