Documentation

Read the complete documentation on Read the Docs.

Why omniconf?

Configuring applications can be hard, and it doesn’t help that there are many different (and valid) ways to do it:

• cli arguments

• config files: ConfigObj (.ini like), JSON, YAML, TOML

• environment variables

Each of these methods are a valid way to configure an application, and each have their own strengths. This library aims to make configuring the application easier, and allows you to use multiple configuration backends transparently.

To get started, take a look here.

Changes

For an up-to-date changelog, see ChangeLog.

See the docs for supported Python versions.

License

omniconf is licensed under LGPLv3. See the LICENSE file for details.

Contributing

To contribute, base your changes on the develop branch. Use init.sh to install the required Python version using pyenv and uv to manage a virtualenv. Activate the virtualenv using source .venv/bin/activate.

After the initial setup, use init.sh at any time to bring your environment up-to-date with the latest requirements.

$ ./init.sh
Installing Python version 3.x.x using pyenv
- Install dependencies using uv
Using CPython 3.x.x interpreter at: /home/user/.pyenv/versions/3.x.x/bin/python3.x
Creating virtual environment at: .venv
...
- Installing pre-commit hook
pre-commit installed at .git/hooks/pre-commit

$ source .venv/bin/activate
# Start developing

Make sure your contribution doesn’t break any existing tests, and add relevant new tests. You can run the test suite using just:

$ just pytest # run full test suite
$ just mypy   # check typing with both mypy and basedpyright

To check for style issues, just run the test suite, ruff is automatically called for linting and formatting checks, and mypy for typing.

When you’re done, open a merge request.