File: README.rst

package info (click to toggle)
python-confspirator 0.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 320 kB
  • sloc: python: 2,388; makefile: 20
file content (40 lines) | stat: -rw-r--r-- 1,276 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
CONFspirator: Plot better configs!
==================================

.. image:: http://img.shields.io/pypi/v/confspirator.svg
    :target: https://pypi.python.org/pypi/confspirator

An offshoot of OpenStack's `oslo.config`_ with a focus on nested
configuration groups, and the ability to use yaml and toml instead of
flat ini files.

CONFspirator doesn't include any command-line integrations currently
so you will need to add a command to your application to export a
generated config using the built in functions.

It does have support for loading in config files, or a preloaded
config dictionary against your config group tree.

The library's focus is on in-code defaults and config field validation,
while giving you a lot of power when dealing with nesting, dynamic config
loading for plugins, and useful overlay logic.

It allows you to define sane defaults, document your config, validate
the values when loading it in, and provides useful ways of working
with that config during testing.

.. _oslo.config: https://github.com/openstack/oslo.config

Installation
------------

::

    pip install confspirator

Documentation
-------------

For more information and examples of usage `check out the docs`_.

.. _check out the docs: https://confspirator.readthedocs.io