academic_observatory_workflows.config
=====================================

.. py:module:: academic_observatory_workflows.config


Classes
-------

.. autoapisummary::

   academic_observatory_workflows.config.Tag
   academic_observatory_workflows.config.TestConfig


Functions
---------

.. autoapisummary::

   academic_observatory_workflows.config.project_path
   academic_observatory_workflows.config.construct_module_path


Module Contents
---------------

.. py:class:: Tag

   DAG tag.


   .. py:attribute:: academic_observatory
      :value: 'academic-observatory'



   .. py:attribute:: data_quality
      :value: 'data-quality'



.. py:function:: project_path(*subpaths: str) -> str

   Make a path to a file or folder within the Academic Observatory Workflows project.

   :param subpaths: any sub paths.
   :return: a path to a file or folder.


.. py:function:: construct_module_path(*parts: str) -> str

   Constructs the full module path given parts of a path.


.. py:class:: TestConfig

   Common parameters for end to end and unit testing


   .. py:attribute:: gcp_project_id
      :type:  str


   .. py:attribute:: gcp_data_location
      :type:  str


   .. py:attribute:: http_host_url
      :type:  str
      :value: 'host.minikube.internal'



   .. py:attribute:: http_port
      :type:  int
      :value: 5080



   .. py:attribute:: ftp_host_url
      :type:  str
      :value: 'host.minikube.internal'



   .. py:attribute:: ftp_port
      :type:  int
      :value: 5021



   .. py:attribute:: gke_image
      :type:  str
      :value: 'academic-observatory:test'



   .. py:attribute:: gke_namespace
      :type:  str
      :value: 'default'



   .. py:attribute:: gke_cluster_connection
      :type:  dict