Pyaconf is a config library that is built around python dictionary and supports dynamic python, json, yaml, and ini formats with inheritance. It features:
- 4 formats (pyaconf [python], yaml, json, ini) that can be layered on top of each other,
- dynamic pyaconf (python) format,
- include feature that can layer combine the 4 formats hierarchically,
- “merge” capability that allows to override values by the topmost layer,
- jinja2 template substitution capability that can be injected at various layers of override and dictionary hierarchies,
- simple 3 function (load, merge, and dump) Python API, and
- command line utility that allows us to use all these features from the command line
- All configs are json compatible dicts.
- Supports layered configs (inheritance) via
__include__dict entry, for example, the following yaml config would read the dictionary defined from configboo.jsonand then will update it withuserandpasswordfrom this config:
__include__: boo.json
user: romeo
password: romeoalpha- Includes may be used at any level and apply only to its layer.
- Simple API:
load,dump, and for more advanced usemerge. - Supports dynamic configs written in Python
.pyaconf, for example:
import os
def config():
return dict(
__include__ = ["secret.yml"],
user = "romeo",
password = os.environ['PASSWORD'],
database = dict(
__include__ = "db.ini",
),
)- Allows to output configs in
.jsonand.yaml. Provides two shell scripts. - Supports
.iniinput format as understood by python'sconfigparser. - Supports Jinji2 templates, you just need to add
.j2or.jinji2extension to your config file and it will be processed by Jinji2. For example:
user: {{ username }}
password = {{ password }}- The dictionary that contains includes serves as a context for these includes. For template includes, the dictionary is passed as a context to the template processing. For non-template includes, the dictionary merges with the include. When all includes processed this way, they all merge together.
__include__: [a.yaml.j2, b.yaml]
x: 1
y: 2- Another example with template:
# common.yaml.j2
host: local
user: {{ username }}
password: {{ password }}
credentials: [{{ password }}, {{username}}]# devel.yaml
__include__: common.yaml.j2
username: Donald
password: Trump
office: 113D# pyaconf_render -f json devel.yaml
{
"credentials": [
"Trump",
"Donald"
],
"host": "local",
"password": "Trump",
"user": "Donald"
}