mainframe.constants
===================

.. py:module:: mainframe.constants


Attributes
----------

.. autoapisummary::

   mainframe.constants.GIT_SHA
   mainframe.constants.mainframe_settings
   mainframe.constants.Sentry


Classes
-------

.. autoapisummary::

   mainframe.constants.EnvConfig
   mainframe.constants.Mainframe
   mainframe.constants._Sentry


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

.. py:data:: GIT_SHA

.. py:class:: EnvConfig(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, Ellipsis] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_prefix: str | None = None, _secrets_dir: str | pathlib.Path | None = None, **values: Any)

   Bases: :py:obj:`pydantic_settings.BaseSettings`


   Our default configuration for models that should load from .env files.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].


.. py:class:: Mainframe(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, Ellipsis] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_prefix: str | None = None, _secrets_dir: str | pathlib.Path | None = None, **values: Any)

   Bases: :py:obj:`EnvConfig`


   Our default configuration for models that should load from .env files.


   .. py:attribute:: client_origin_url
      :type:  str
      :value: ''



   .. py:attribute:: auth0_domain
      :type:  str
      :value: ''



   .. py:attribute:: auth0_audience
      :type:  str
      :value: ''



   .. py:attribute:: reporter_url
      :type:  str
      :value: ''



   .. py:attribute:: db_url
      :type:  str
      :value: 'postgresql+psycopg2://postgres:postgres@localhost:5432/dragonfly'



   .. py:attribute:: db_connection_pool_max_size
      :type:  int
      :value: 15


      The max number of concurrent connections


   .. py:attribute:: db_connection_pool_persistent_size
      :type:  int
      :value: 5


      The number of concurrent connections to maintain in the connection pool


   .. py:attribute:: dragonfly_github_token
      :type:  str


   .. py:attribute:: job_timeout
      :type:  int


   .. py:attribute:: log_config_file
      :type:  str
      :value: 'logging/development.toml'



.. py:data:: mainframe_settings

.. py:class:: _Sentry(_case_sensitive: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, Ellipsis] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_prefix: str | None = None, _secrets_dir: str | pathlib.Path | None = None, **values: Any)

   Bases: :py:obj:`EnvConfig`


   Our default configuration for models that should load from .env files.


   .. py:attribute:: dsn
      :type:  str
      :value: ''



   .. py:attribute:: environment
      :type:  str
      :value: 'production'



   .. py:attribute:: release_prefix
      :type:  str
      :value: 'dragonfly-mainframe'



.. py:data:: Sentry