academic_observatory_workflows.ror_telescope.telescope

Classes

DagParams

param dag_id:

the id of the DAG.

Functions

create_dag(→ airflow.DAG)

Construct a RorTelescope instance.

Module Contents

class academic_observatory_workflows.ror_telescope.telescope.DagParams(dag_id: str, cloud_workspace: observatory_platform.airflow.workflow.CloudWorkspace, bq_dataset_id: str = 'ror', bq_table_name: str = 'ror', api_bq_dataset_id: str = 'dataset_api', schema_folder: str = project_path('ror_telescope', 'schema'), dataset_description: str = 'The Research Organization Registry (ROR) database: https://ror.org/', table_description: str = 'The Research Organization Registry (ROR) database: https://ror.org/', ror_conceptrecid: int = 6347574, start_date: pendulum.DateTime = pendulum.datetime(2021, 9, 1), schedule: str = '@weekly', catchup: bool = True, max_active_runs: int = 1, retries: int = 3)[source]
Parameters:

  • dag_id – the id of the DAG.

  • cloud_workspace – the cloud workspace settings.

  • bq_dataset_id – the BigQuery dataset id.

  • bq_table_name – the BigQuery table name.

  • api_dataset_id – the Dataset ID to use when storing releases.

  • schema_folder – the SQL schema path.

  • dataset_description – description for the BigQuery dataset.

  • table_description – description for the BigQuery table.

  • observatory_api_conn_id – the Observatory API connection key.

  • ror_conceptrecid – the Zenodo conceptrecid for the ROR dataset.

  • start_date – the start date of the DAG.

  • schedule – the schedule interval of the DAG.

  • catchup – whether to catchup the DAG or not.

  • max_active_runs – the maximum number of DAG runs that can be run at once.

  • retries – the number of times to retry a task.

dag_id[source]
cloud_workspace[source]
bq_dataset_id = 'ror'[source]
bq_table_name = 'ror'[source]
api_bq_dataset_id = 'dataset_api'[source]
schema_folder[source]
dataset_description = 'The Research Organization Registry (ROR) database: https://ror.org/'[source]
table_description = 'The Research Organization Registry (ROR) database: https://ror.org/'[source]
ror_conceptrecid = 6347574[source]
start_date[source]
schedule = '@weekly'[source]
catchup = True[source]
max_active_runs = 1[source]
retries = 3[source]
academic_observatory_workflows.ror_telescope.telescope.create_dag(dag_params: DagParams) → airflow.DAG[source]

Construct a RorTelescope instance.