2022-04-19 02:09:05 +00:00
|
|
|
####
|
|
|
|
|
cfig
|
|
|
|
|
####
|
|
|
|
|
|
2022-04-20 02:15:10 +00:00
|
|
|
The :mod:`cfig` package provides a simple but powerful configuration manager for Python applications.
|
2022-04-19 02:09:05 +00:00
|
|
|
|
|
|
|
|
|
2022-04-20 23:32:20 +00:00
|
|
|
Pitch
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
Ever had trouble making your application configurable?
|
|
|
|
|
Ever fought with global objects which impeded code reuse?
|
|
|
|
|
Ever had a confused user ask you how to configure your application?
|
|
|
|
|
In that case, :mod:`cfig` is for you!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Minimal example
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
.. image:: example-definition.png
|
|
|
|
|
|
|
|
|
|
.. image:: example-usage.png
|
|
|
|
|
|
|
|
|
|
.. image:: example-configuration.png
|
|
|
|
|
|
|
|
|
|
|
2022-04-20 20:29:40 +00:00
|
|
|
Table of contents
|
|
|
|
|
=================
|
2022-04-19 02:09:05 +00:00
|
|
|
|
2022-04-20 20:29:40 +00:00
|
|
|
.. toctree::
|
2022-04-19 02:09:05 +00:00
|
|
|
|
2022-04-20 20:29:40 +00:00
|
|
|
goals
|
2022-04-20 23:32:20 +00:00
|
|
|
installation
|
|
|
|
|
quickstart
|
2022-04-20 20:29:40 +00:00
|
|
|
reference
|
|
|
|
|
glossary
|
2022-04-19 02:09:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Other tables and links
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
