saturnin._scripts.commands.recipes

Saturnin recipe commands

Globals

saturnin._scripts.commands.recipes.app

Typer command group for recipe management commands

Parameters:

• args (Any) –

• kwargs (Any) –

Return type:

Any

Command functions

saturnin._scripts.commands.recipes.list_recipes() → None

List installed Saturnin recipes.

Return type:

None

saturnin._scripts.commands.recipes.show_recipe(recipe_name: str = <typer.models.ArgumentInfo object>, section: str = <typer.models.OptionInfo object>, raw: bool = <typer.models.OptionInfo object>)

It analyzes the content of the recipe and displays its structure and configuration according to the default sections of the container configuration. If the recipe contains several variants, it is necessary to enter the name of the specific section for the configuration of the container to display them.

Alternatively, it is possible to display the entire recipe in text form (with syntax highlighting).

Parameters:

• recipe_name (str) –

• section (str) –

• raw (bool) –

saturnin._scripts.commands.recipes.edit_recipe(recipe_name: str = <typer.models.ArgumentInfo object>)

Edit recipe.

Parameters:

recipe_name (str) –

saturnin._scripts.commands.recipes.create_recipe(plain: bool = <typer.models.OptionInfo object>, recipe_name: str = <typer.models.ArgumentInfo object>, components: ~typing.List[str] = <typer.models.ArgumentInfo object>)

Creates a recipe template that uses the specified Butler services. Such a template contains only default settings and usually needs to be modified to achieve the desired results.

Parameters:

• plain (bool) –

• recipe_name (str) –

• components (List[str]) –

saturnin._scripts.commands.recipes.install_recipe(recipe_name: str = <typer.models.OptionInfo object>, recipe_file: ~pathlib.Path = <typer.models.OptionInfo object>, app_id: str = <typer.models.OptionInfo object>)

Installs a new recipe from an external recipe file or from an installed application. Once installed, recipe can be executed immediately with the run command.

Parameters:

• recipe_name (str) –

• recipe_file (Path) –

• app_id (str) –

saturnin._scripts.commands.recipes.uninstall_recipe(recipe_name: str = <typer.models.ArgumentInfo object>, save_to: ~pathlib.Path = <typer.models.OptionInfo object>)

Uninstall recipe. Can optionally save the recipe file

Parameters:

• recipe_name (str) –

• save_to (Path) –

saturnin._scripts.commands.recipes.run_recipe(ctx: ~typer.models.Context, section: str = <typer.models.OptionInfo object>, print_outcome: bool = <typer.models.OptionInfo object>, config: ~typing.List[str] = <typer.models.OptionInfo object>, quiet: bool = <typer.models.OptionInfo object>, main_thread: bool = <typer.models.OptionInfo object>) → None

Runs Saturnin recipe.

Parameters:

• ctx (Context) –

• section (str) –

• print_outcome (bool) –

• config (List[str]) –

• quiet (bool) –

• main_thread (bool) –

Return type:

None