Metadata-Version: 2.1
Name: compendium
Version: 0.1.2.post5
Summary: Simple layered configuraion tool
Home-page: https://github.com/kuwv/python-compendium
License: Apache-2.0
Keywords: configuration,configuration management
Author: Jesse P. Johnson
Author-email: jpj6652@gmail.com
Requires-Python: >=3.6.2,<4.0.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: xml
Requires-Dist: anytree (>=2.8.0,<3.0.0)
Requires-Dist: dpath (>=2.0.1,<3.0.0)
Requires-Dist: ruamel.yaml (>=0.16.10,<0.17.0)
Requires-Dist: tomlkit (>=0.7.0,<0.8.0)
Requires-Dist: xmltodict (>=0.12.0,<0.13.0); extra == "xml"
Project-URL: Documentation, https://kuwv.github.io/python-compendium
Description-Content-Type: text/markdown

# Compendium

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Build Status](https://travis-ci.org/kuwv/python-compendium.svg?branch=master)](https://travis-ci.org/kuwv/python-compendium)
[![codecov](https://codecov.io/gh/kuwv/python-compendium/branch/master/graph/badge.svg)](https://codecov.io/gh/kuwv/python-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

```python
>>> import os
>>> from compendium.loader import ConfigFile

>>> basepath = os.path.join(os.getcwd(), 'tests')
>>> filepath = os.path.join(basepath, 'config.toml')

>>> cfg = ConfigFile()
>>> settings = cfg.load(filepath=filepath)

# Simple lookup for title
>>> settings['/title']
'TOML Example'

# Query values within list
>>> settings.values('/servers/**/ip')
['10.0.0.1', '10.0.0.2']

# Update setting
>>> settings['/database/server']
'192.168.1.1'

>>> 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.

```python
>>> from tempfile import NamedTemporaryFile
>>> from textwrap import dedent

>>> from compendium.config_manager import ConfigManager

>>> try:
...     # Create first mock config file
...     file1 = NamedTemporaryFile(mode='wt', suffix='.toml')
...     _ = file1.write(
...         dedent(
...             """\
...             [default]
...             foo = "bar"
...             foo2 = "bar2"
...             """
...         )
...     )
...     _ = file1.seek(0)
...
...     # Create first mock config file
...     file2 = NamedTemporaryFile(mode='wt', suffix='.toml')
...     _ = file2.write(
...         dedent(
...             """\
...             [example.settings]
...             foo = "baz"
...             """
...         )
...     )
...     _ = file2.seek(0)
...
...     # Retrieve settings from config files
...     cfg = ConfigManager(name='app', filepaths=[file1.name, file2.name])
...
...     # Get using dpath
...     cfg.get('/default/foo2')
...
...     # Lookup with multi-query
...     cfg.lookup('/example/settings/foo', '/default/foo')
...
... finally:
...     file1.close()
...     file2.close()
'bar2'
'baz'

```

