.. confmodel documentation master file, created by
   sphinx-quickstart on Thu May 29 15:06:07 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================================================================
confmodel: A declarative configuration access and validation system.
====================================================================

.. centered:: Release |release|


.. note::

   This documentation is not yet complete. It will be updated and improved as
   we work on confmodel.

   Thank you for your attention.


confmodel is a tool for accessing, validating, and documenting configuration
parameters. Config specifications are written as Python classes with
specialised field attributes (similar to Django forms) and then instantiated
with configuration data. The configuration is validated and fields are
available as parameters on the config object (similar to Django models,
although read-only).


Installation
============

.. code-block:: bash

   $ pip install confmodel


Documentation
=============

.. toctree::
   :maxdepth: 2
   :includehidden:

   usage
   advanced
   api
   api_fields
   api_fallbacks
