ogdc_runner.recipe module

ogdc_runner.recipe.clone_recipes_repo(repo_url: str, ref: str = 'main') → Generator[Path, None, None]

Clone a git repository at a specific ref.

Parameters:

  • repo_url (str) – Git repository URL

  • ref (str) – Git ref like ‘main’ or ‘develop’

Return type:

Generator[Path, None, None]

ogdc_runner.recipe.find_recipe_dirs(recipes_dir: Path) → list[Path]

Find all directories containing meta.yml in the recipes directory.

Parameters:

recipes_dir (Path)

Return type:

list[Path]

ogdc_runner.recipe.get_recipe_config(recipe_directory: Path, *, check_urls: bool = False) → RecipeConfig

Extract config from a recipe configuration file (meta.yml).

Parameters:

  • recipe_directory (Path) – Path to the recipe directory containing meta.yml

  • check_urls (bool) – If True, validate that all URL-type input parameters are accessible

Return type:

RecipeConfig

ogdc_runner.recipe.stage_ogdc_recipe(recipe_location: str)

Stages the recipe directory.

Parameters:

recipe_location (str)

ogdc_runner.recipe.validate_all_recipes_in_repo(repo_url: str, ref: str = 'main', *, check_urls: bool = False) → None

Validate all recipes in a git repository.

Parameters:

  • repo_url (str) – Git repository URL

  • ref (str) – Git reference (branch, tag, or commit)

  • check_urls (bool) – If True, validate that all URL-type input parameters are accessible

Return type:

None