A Python library that makes configuring your application independent from your configuration backend.
.. image:: https://img.shields.io/gitlab/pipeline-status/CYSO%2Fopen-source%2Fomniconf?branch=develop&logo=gitlab :alt: Gitlab Pipeline Status
.. image:: https://img.shields.io/gitlab/pipeline-coverage/CYSO%2Fopen-source%2Fomniconf?branch=develop&logo=gitlab :alt: Gitlab Code Coverage
.. image:: https://img.shields.io/pypi/l/omniconf :alt: License :target: https://pypi.python.org/pypi/omniconf
.. image:: https://img.shields.io/pypi/v/omniconf :alt: PyPI version :target: https://pypi.python.org/pypi/omniconf
.. image:: https://img.shields.io/pypi/pyversions/omniconf :alt: Supported Python versions :target: https://pypi.python.org/pypi/omniconf
.. image:: https://img.shields.io/pypi/implementation/omniconf :alt: Supported Python implementations :target: https://pypi.python.org/pypi/omniconf
A Python library that makes configuring your application independent from your configuration backend.
Read the complete documentation on Read the Docs <http://omniconf.readthedocs.io/en/latest/>_.
Configuring applications is hard, and it doesn't help that there are many different (and valid) ways to do it:
Each of this methods are a valid way to configure an application, and each have their own strengths. Cli arguments are most suited for tools and daemons. Configuration files are suited for applications that have more complex requirements. Environment variables and key/value stores are handy when using containers. You may even want to use a combination of methods (not yet implemented).
This library aims to make configuring the application easier, and allows you to use multiple configuration backends transparently.
For up-to-date examples, take a look here <http://omniconf.readthedocs.io/en/latest/examples.html>_.
For an up-to-date changelog, see ChangeLog_.
.. _ChangeLog: ChangeLog
omniconf is licensed under LGPLv3. See the LICENSE file for details.
To contribute, base your changes on the develop branch. Use init.sh to install the required Python version using pyenv and
setup a virtualenv in vendor/. Activate the virtualenv using source vendor/bin/activate. After the initial setup, use
init.sh at any time to bring your environment up-to-date with the latest requirements.
.. code-block:: bash
$ ./init.sh Installing Python version 3.x.x using pyenv Creating Python venv named 'vendor'
Make sure your contribution doesn't break any existing tests, and add relevant new tests. You can run the test suite using tox:
.. code-block:: bash
$ tox
To check for style issues, just run the test suite, ruff is automatically called for linting and formatting checks.
When you're done, open a pull request on Github.
FAQs
A Python library that makes configuring your application independent from your configuration backend.
We found that omniconf demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
