Simple layered configuraion tool
Project description
Compendium
Overview
Compendium is a layered configuration management tool. It has the capability to manage configuration files writen in JSON, TOML, XML and YAML. Settings from these configuration files can then be managed easily with the help of dpath.
Documentation
https://kuwv.github.io/python-compendium/
Install
pip install compendium
Manage a configuration file
>>> import os
>>> from compendium import ConfigFile
>>> basedir = os.path.join(os.getcwd(), 'tests')
>>> filepath = os.path.join(basedir, 'config.toml')
>>> cfg = ConfigFile(filepath)
>>> settings = cfg.load()
Simple lookup for title
>>> settings['/title']
'TOML Example'
Query values within list
>>> settings.values('/servers/**/ip')
['10.0.0.1', '10.0.0.2']
Check the current server IP address
>>> settings['/database/server']
'192.168.1.1'
Update the server IP address
>>> settings['/database/server'] = '192.168.1.2'
>>> settings['/database/server']
'192.168.1.2'
Check the database max connections
>>> settings['/database/connection_max']
5000
Delete the max connections
>>> del settings['/database/connection_max']
Check that the max connections have been removed
>>> settings.get('/database/connection_max')
Manage multiple layered configurations
The ConfigManager
is a layered dictionary mapping. It allows multiple
configurations to be loaded from various files. Settings from each file
is overlapped in order so that the first setting found will be used.
>>> import os
>>> from compendium import ConfigManager
Reference config files from examples
>>> basedir = os.path.join(os.getcwd(), 'examples', 'config_manager')
>>> config1 = os.path.join(basedir, 'config1.toml')
>>> config2 = os.path.join(basedir, 'config2.toml')
Retrieve settings from config files
>>> cfg = ConfigManager(name='app', filepaths=[config1, config2])
Get using dpath
>>> cfg.get('/default/foo2')
'bar2'
Lookup with multi-query
>>> cfg.lookup('/example/settings/foo', '/default/foo')
'baz'
Manage nested configurations
>>> import os
>>> from anytree import RenderTree
>>> from compendium.config_manager import ConfigManager, TreeConfigManager
>>> basedir = os.path.join(os.getcwd(), 'examples', 'tree')
>>> cfg = TreeConfigManager(
... name='fruit',
... basedir=basedir,
... filename='node.toml',
... load_root=True,
... load_children=True,
... )
>>> cfg.defaults == {}
True
>>> 'succulant' in cfg['/fruit/children']
True
>>> succulant = cfg.get_config('/fruit/succulant')
>>> succulant.name
'succulant'
Manage configurations using Hierarchy File System (HFS)
TBD
Development
poetry shell
poetry install
python -m doctest README.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
compendium-0.1.3.tar.gz
(18.6 kB
view hashes)
Built Distribution
compendium-0.1.3-py3-none-any.whl
(22.2 kB
view hashes)
Close
Hashes for compendium-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3e968ac67dd25f3d7722537293897c56e12a1fbfd8d28de7637014d462755ad |
|
MD5 | 9eafd399cb4291ab077b180db2cba95e |
|
BLAKE2b-256 | f757995a0a7846fe7179af3d32a95ed4042c97650263c41a94a7dced0f63d969 |