academic_observatory_workflows.config

Module Contents

Classes

Tag

DAG tag.

Functions

test_fixtures_folder(→ str)

Get the path to the Academic Observatory Workflows test data directory.

schema_folder(→ str)

Return the path to the database schema template folder.

sql_folder(→ str)

Return the path to the workflow SQL template folder.

construct_module_path(→ str)

Constructs the full module path given parts of a path.
class academic_observatory_workflows.config.Tag[source]

DAG tag.

academic_observatory = 'academic-observatory'[source]
data_quality = 'data-quality'[source]
academic_observatory_workflows.config.test_fixtures_folder(*subdirs: str, workflow_module: str | None = None) → str[source]

Get the path to the Academic Observatory Workflows test data directory.

Parameters:

  • *subdirs –

    any subdirectories.

  • workflow_module – Optional, name of the workflow. Only to be included if the schema for the workflow is in

the directory academic_observatory_workflows.workflows.{workflow_name}.schema :return: the test data directory.

academic_observatory_workflows.config.schema_folder(workflow_module: str | None = None) → str[source]

Return the path to the database schema template folder.

Parameters:

workflow_module – Optional, name of the workflow. Only to be included if the schema for the workflow is in

the directory academic_observatory_workflows.workflows.{workflow_module}.schema :return: the path.

academic_observatory_workflows.config.sql_folder(workflow_module: str | None = None) → str[source]

Return the path to the workflow SQL template folder.

Parameters:

workflow_module – Optional, name of the workflow. Only to be included if the sql for the workflow is in

the directory academic_observatory_workflows.workflows.{workflow_module}.schema :return: the path.

academic_observatory_workflows.config.construct_module_path(*parts: str) → str[source]

Constructs the full module path given parts of a path.