pollination_dsl.package module

pollination_dsl.package.load(package_name: str, baked: bool = False) → Union[Plugin, BakedRecipe, Recipe]

Load Queenbee Plugin or Recipe from Python package.

package_name: Python package name (e.g. honeybee-radiance-pollination) baked: A boolean value to indicate wether to return a Recipe or a BakedRecipe.

pollination_dsl.package.package(package_name: str, readme: Optional[str] = None) → None

Package a plugin or a recipe and add it to Queenbee local repository.

Parameters:

  • package_name – Python package name (e.g. honeybee-radiance-pollination)

  • readme – Readme contents as a string.

pollination_dsl.package.package_recipe_dependencies(recipe: Recipe) → None

Try to load/package recipe dependencies from local registry.

If the dependency is not available in local registry then it will try to package it from a local python installation. If that also fails it will try to pull it down using pip install.

pollination_dsl.package.translate(package_name: str, target_folder: str, baked: bool = False, readme: Optional[str] = None) → str

Translate Python package to a Queenbee plugin or recipe.

BakedRecipes are written to a single file.

Parameters:

  • package_name – Python package name. The package must be installed in the environment that this command being executed.

  • target_folder – Path to folder to write this plugin.

  • baked – A boolean to write the Recipes as BackedRecipes. It will be ignored for plugins.

  • readme – Readme contents as a string.

Returns:

str – path to the generated folder or file.