Functions

display(config_file_path)

Display a summary of the supplied config file. This method prints to sys.stdout and returns None.

Params: config_file_path str
Returns: None


get_arguments(yaml_config_file)

Gets global pipeline arguments as defined in the pipeline's 'config.yaml' under section pipeline_arguments. Where no arguments are defined, returns None.

All pipeline_arguments defined are returned as a key:value dictionary. All arguments which have export_environment_variable: true will also export that argument into the environment.

Params: yaml_config_file str or Path
Returns: retrieved arguments dict or None


populate_env_variables(argument_dict)

Clears any pre-existing environment variable of the same name, then populates it from the provided argument_dict. Returns None.

Params: argument_dict dict
Returns: None


retrieve_gitlab(gitlab_repository_url, config_file_name)

Retrieve a single configuration file from a gitlab repository. This method expects the gitlab repository to have a directory named 'config' containing the requested configuration file.

The configuration file is retrieved and placed in the current working directory.

This method returns the Path to the downloaded configuration file, or None if not successful.

Params:
- gitlab_repository_url str
- config_file_name str
Returns: path to retrieved config Path or None


setup_datastores(directory_path, config_file)

Set up the datastores using the provided root directory and yaml config file. This method always returns None.

Params:
- directory_path str
- config_file str
Returns: None