Metadata-Version: 2.1
Name: python-twonms-config
Version: 0.1.1
Summary: Python package to manage configs based on OmegaConf.
Home-page: https://github.com/mwallraf/python_twonms_config
License: MIT
Author: Maarten Wallraf
Author-email: mwallraf@2nms.com
Requires-Python: >=3.6.1,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: black (==20.8b1); extra == "test"
Requires-Dist: fire (==0.4.0)
Requires-Dist: flake8 (==3.8.4); extra == "test"
Requires-Dist: flake8-docstrings (>=1.6.0,<2.0.0); extra == "test"
Requires-Dist: isort (==5.6.4); extra == "test"
Requires-Dist: livereload (>=2.6.3,<3.0.0)
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: mkdocs (>=1.1.2,<2.0.0); extra == "doc"
Requires-Dist: mkdocs-autorefs (==0.1.1); extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=1.0.0,<2.0.0); extra == "doc"
Requires-Dist: mkdocs-material (>=6.1.7,<7.0.0); extra == "doc"
Requires-Dist: mkdocs-material-extensions (>=1.0.1,<2.0.0)
Requires-Dist: mkdocstrings (>=0.13.6,<0.14.0); extra == "doc"
Requires-Dist: omegaconf (>=2.1.1,<3.0.0)
Requires-Dist: pip (>=20.3.1,<21.0.0); extra == "dev"
Requires-Dist: pre-commit (>=2.12.0,<3.0.0); extra == "dev"
Requires-Dist: pytest (==6.1.2); extra == "test"
Requires-Dist: pytest-cov (==2.10.1); extra == "test"
Requires-Dist: python-dotenv (>=0.19.2,<0.20.0)
Requires-Dist: toml (>=0.10.2,<0.11.0); extra == "dev"
Requires-Dist: tox (>=3.20.1,<4.0.0); extra == "dev"
Requires-Dist: twine (>=3.3.0,<4.0.0); extra == "dev"
Requires-Dist: virtualenv (>=20.2.2,<21.0.0); extra == "dev"
Description-Content-Type: text/markdown

# Python 2NMS config manager

<p align="center">
<a href="https://pypi.python.org/pypi/python_twonms_config">
    <img src="https://img.shields.io/pypi/v/python_twonms_config.svg"
        alt = "Release Status">
</a>

<a href="https://github.com/mwallraf/python_twonms_config/actions">
    <img src="https://github.com/mwallraf/python_twonms_config/actions/workflows/release.yml/badge.svg?branch=release" alt="CI Status">
</a>

<a href="https://mwallraf.github.io/python_twonms_config/">
    <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Documentation Status">
</a>

</p>

Python package to manage application configurations. This is a wrapper around the OmegaConf create function.

This package makes it easy to define parameters for your application. It's possible to define parameters in different ways (in order of precedence):

-   programmatically defined default values
-   environment variables/dotenv files
-   configuration files in YAML format
-   cli arguments

## Documentation

Check out the [Github Docs](https://mwallraf.github.io/python_twonms_config/)

## Features

-   generates an [OmegaConf](https://omegaconf.readthedocs.io) dictionary object
-   supports environment variables
-   supports dotenv
-   reads yaml config files
-   supports cli parameters
-   allows programmatic initialization of parameters

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [zillionare/cookiecutter-pypackage](https://github.com/zillionare/cookiecutter-pypackage) project template.

