carlos-jenkins/confspec

Configuration Specification Manager.

confspec

DEPRECATED

This project is no longer maintained.

There is no direct replacement, but a better approach could be to parse your configuration options and validate its schema using Cerberus:

https://docs.python-cerberus.org/

---

About

confspec is a Python library - framework that allows an application to handle all it's configuration options easily and with safety.

With confspec you don't need to worry about parsing, importing or exporting configuration files. Nor casting or trying to parse, convert or interpret datatypes for each option. It will even handle the process to try to identify if the option is semantically valid and how to react when your options change.

To use confspec you need to:

1. Define a specification for your options.
2. Create a manager to handle it.
3. Enjoy life. Now you just need to care about reading and changing your options. confspec will take care of reading, parsing, interpreting, validating, notifying, writing, exporting, importing, etc.

For a more in-depth documentation visit the project home page at:

http://confspec.readthedocs.org/

Installation

pip install confspec

Development

https://github.com/carlos-jenkins/confspec

Run code QA:

pip install tox
tox

Documentation

User guide and API Reference can be found in:

http://confspec.readthedocs.org/

To build it from source execute:

pip install sphinx sphinx_rtd_theme
cd doc/
make html

TODO

• Finish (start) to write tutorial and improve documentation.
• Improve Coverage.
• Add to file system ConfigOpt's a create keyword.

Possible Improvements

• Add a XML format provider.
• Add a YAML format provider.
• Add a SQLite format provider.
• Add capability for plugins to register custom FormatProvider or ConfigOption subclasses.
• Add integration with argparse.
• Gtk config dialog autogeneration.