.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

whiteprints.environment
=======================

.. py:module:: whiteprints.environment

.. autoapi-nested-parse::

   Manage environment variables.



Attributes
----------

.. autoapisummary::

   whiteprints.environment.ENVIRONMENT_FILE


Functions
---------

.. autoapisummary::

   whiteprints.environment.load_dotenv


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

.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

.. py:data:: ENVIRONMENT_FILE
   :type:  Final

   The default path to the dotenv file.

.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

.. py:function:: load_dotenv(environment_file: pathlib.Path) -> None

   Load a dotenv file to os.environ.

   A dotenv file stores the environment variables useful to customise the
   behaviour of the app.

   :param environment_file: the dotenv file to load.