https://github.com/iteriodata/env_var_config
Parsing configuration from environment variables as typing.NamedTuple
https://github.com/iteriodata/env_var_config
config env python variable
Last synced: 14 days ago
JSON representation
Parsing configuration from environment variables as typing.NamedTuple
- Host: GitHub
- URL: https://github.com/iteriodata/env_var_config
- Owner: iteriodata
- License: mit
- Created: 2018-06-12T17:53:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T17:38:33.000Z (about 5 years ago)
- Last Synced: 2025-10-26T11:24:53.488Z (6 months ago)
- Topics: config, env, python, variable
- Language: Python
- Size: 8.79 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
env_var_config
==============
This project allows you to describe the configuration of your application as a
``typing.NamedTuple``, like so:
.. code-block:: python
import typing
class MyAppConfig(typing.NamedTuple):
some_string: str
some_int: int
some_float: float
some_bool: bool = True
Then, gather the configuration from the environment variables:
.. code-block:: python
import env_var_config
config = env_var_config.gather_config_for_class(MyAppConfig)
The code will look for variables that are called like the fields of the tuple, but uppercase.
As you might have noticed, you can set default values on the fields.
If the fields with defaults are not found in the environment, they're set to their default value
(which is quite unsurprising).
If a value without a default is missing, though, an error will be raised.
That is, unless you set ``allow_empty`` option to ``True``
in the call to ``gather_config_for_class``.
Then all missing values will be initialized with the default value for their type,
such as an empty string for ``str``, 0 for ``int``, etc.
Installation
------------
.. code-block:: bash
pip install env_var_config