https://github.com/omry/omegaconf

Flexible Python configuration system. The last one you will ever need.
https://github.com/omry/omegaconf

configuration-files configuration-loader python python-types schema-validator yaml yaml-configuration

Last synced: 6 days ago
JSON representation

Flexible Python configuration system. The last one you will ever need.

• Host: GitHub
• URL: https://github.com/omry/omegaconf
• Owner: omry
• License: bsd-3-clause
• Created: 2018-09-03T14:59:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-19T22:19:44.000Z (3 months ago)
• Last Synced: 2025-04-01T19:12:49.339Z (13 days ago)
• Topics: configuration-files, configuration-loader, python, python-types, schema-validator, yaml, yaml-configuration
• Language: Python
• Homepage:
• Size: 10 MB
• Stars: 2,094
• Watchers: 18
• Forks: 125
• Open Issues: 137
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

• best-of-python - GitHub - 19% open · ⏱️ 30.05.2024): (Configuration)
• awesome-list - OmegaConf - A hierarchical configuration system, with support for merging configurations from multiple sources (YAML config files, dataclasses/objects and CLI arguments) providing a consistent API regardless of how the configuration was created. (Desktop App Development / Python Toolkit)
• jimsghstars - omry/omegaconf - Flexible Python configuration system. The last one you will ever need. (Python)

README

        
# OmegaConf

|  | Description |

| --- | --- |

| Project | [![PyPI version](https://badge.fury.io/py/omegaconf.svg)](https://badge.fury.io/py/omegaconf)[![Downloads](https://pepy.tech/badge/omegaconf/month)](https://pepy.tech/project/omegaconf?versions=1.4.*&versions=2.0.*&versions=2.1.*)![PyPI - Python Version](https://img.shields.io/pypi/pyversions/omegaconf.svg) |

| Code quality| [![CircleCI](https://img.shields.io/circleci/build/github/omry/omegaconf?logo=s&token=5de2f8dc2a0dd78438520575431aa533150806e3)](https://circleci.com/gh/omry/omegaconf)[![Coverage Status](https://coveralls.io/repos/github/omry/omegaconf/badge.svg)](https://coveralls.io/github/omry/omegaconf)[![Total alerts](https://img.shields.io/lgtm/alerts/g/omry/omegaconf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/omry/omegaconf/alerts/)[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/omry/omegaconf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/omry/omegaconf/context:python)|

| Docs and support |[![Documentation Status](https://readthedocs.org/projects/omegaconf/badge/?version=2.0_branch)](https://omegaconf.readthedocs.io/en/2.1_branch/)[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/omry/omegaconf/master?filepath=docs%2Fnotebook%2FTutorial.ipynb)|

OmegaConf is a hierarchical configuration system, with support for merging configurations from multiple sources (YAML config files, dataclasses/objects and CLI arguments)

providing a consistent API regardless of how the configuration was created.

## Releases

### Stable (2.3)

OmegaConf 2.3 is the current stable version.

* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.3.0)

* [Documentation](https://omegaconf.readthedocs.io/en/2.3_branch/)

* [Source code](https://github.com/omry/omegaconf/tree/2.3_branch)

Install with `pip install --upgrade omegaconf`

### Previous release (2.2)

* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)

* [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)

* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

* [Source code](https://github.com/omry/omegaconf/tree/2.1_branch)

Install with `pip install omegaconf==2.1`

### Previous release (2.1)

* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.1.1)

* [Documentation](https://omegaconf.readthedocs.io/en/2.1_branch/)

* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

* [Source code](https://github.com/omry/omegaconf/tree/2.1_branch)

Install with `pip install omegaconf==2.1`

### Previous release (2.0)

* [What's new](https://github.com/omry/omegaconf/releases/tag/v2.0.0)

* [Documentation](https://omegaconf.readthedocs.io/en/2.0_branch/)

* [Slides](https://docs.google.com/presentation/d/e/2PACX-1vT_UIV7hCnquIbLUm4NnkUpXvPEh33IKiUEvPRF850WKA8opOlZOszjKdZ3tPmf8u7hGNP6HpqS-NT5/pub?start=false&loop=false&delayms=3000)

* [Source code](https://github.com/omry/omegaconf/tree/2.0_branch)

Install with `pip install omegaconf==2.0.6`

## Live tutorial

Run the live tutorial: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/omry/omegaconf/master?filepath=docs%2Fnotebook%2FTutorial.ipynb)