:py:mod:`mipcandy.config`
=========================

.. py:module:: mipcandy.config

.. autodoc2-docstring:: mipcandy.config
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`_load <mipcandy.config._load>`
     - .. autodoc2-docstring:: mipcandy.config._load
          :summary:
   * - :py:obj:`_save <mipcandy.config._save>`
     - .. autodoc2-docstring:: mipcandy.config._save
          :summary:
   * - :py:obj:`load_settings <mipcandy.config.load_settings>`
     - .. autodoc2-docstring:: mipcandy.config.load_settings
          :summary:
   * - :py:obj:`save_settings <mipcandy.config.save_settings>`
     - .. autodoc2-docstring:: mipcandy.config.save_settings
          :summary:
   * - :py:obj:`load_secrets <mipcandy.config.load_secrets>`
     - .. autodoc2-docstring:: mipcandy.config.load_secrets
          :summary:
   * - :py:obj:`save_secrets <mipcandy.config.save_secrets>`
     - .. autodoc2-docstring:: mipcandy.config.save_secrets
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`_DIR <mipcandy.config._DIR>`
     - .. autodoc2-docstring:: mipcandy.config._DIR
          :summary:
   * - :py:obj:`_DEFAULT_SETTINGS_PATH <mipcandy.config._DEFAULT_SETTINGS_PATH>`
     - .. autodoc2-docstring:: mipcandy.config._DEFAULT_SETTINGS_PATH
          :summary:
   * - :py:obj:`_DEFAULT_SECRETS_PATH <mipcandy.config._DEFAULT_SECRETS_PATH>`
     - .. autodoc2-docstring:: mipcandy.config._DEFAULT_SECRETS_PATH
          :summary:

API
~~~

.. py:data:: _DIR
   :canonical: mipcandy.config._DIR
   :type: str
   :value: None

   .. autodoc2-docstring:: mipcandy.config._DIR

.. py:data:: _DEFAULT_SETTINGS_PATH
   :canonical: mipcandy.config._DEFAULT_SETTINGS_PATH
   :type: str
   :value: None

   .. autodoc2-docstring:: mipcandy.config._DEFAULT_SETTINGS_PATH

.. py:data:: _DEFAULT_SECRETS_PATH
   :canonical: mipcandy.config._DEFAULT_SECRETS_PATH
   :type: str
   :value: None

   .. autodoc2-docstring:: mipcandy.config._DEFAULT_SECRETS_PATH

.. py:function:: _load(path: str | os.PathLike[str], *, hint: str = 'fill in your settings here') -> mipcandy.types.Settings
   :canonical: mipcandy.config._load

   .. autodoc2-docstring:: mipcandy.config._load

.. py:function:: _save(settings: mipcandy.types.Settings, path: str | os.PathLike[str], *, hint: str = 'fill in your settings here') -> None
   :canonical: mipcandy.config._save

   .. autodoc2-docstring:: mipcandy.config._save

.. py:function:: load_settings(*, path: str | os.PathLike[str] = _DEFAULT_SETTINGS_PATH) -> mipcandy.types.Settings
   :canonical: mipcandy.config.load_settings

   .. autodoc2-docstring:: mipcandy.config.load_settings

.. py:function:: save_settings(settings: mipcandy.types.Settings, *, path: str | os.PathLike[str] = _DEFAULT_SETTINGS_PATH) -> None
   :canonical: mipcandy.config.save_settings

   .. autodoc2-docstring:: mipcandy.config.save_settings

.. py:function:: load_secrets(*, path: str | os.PathLike[str] = _DEFAULT_SECRETS_PATH) -> mipcandy.types.Settings
   :canonical: mipcandy.config.load_secrets

   .. autodoc2-docstring:: mipcandy.config.load_secrets

.. py:function:: save_secrets(secrets: mipcandy.types.Settings, *, path: str | os.PathLike[str] = _DEFAULT_SECRETS_PATH) -> None
   :canonical: mipcandy.config.save_secrets

   .. autodoc2-docstring:: mipcandy.config.save_secrets