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
|
|
|
|
|
=====
|
|
|
|
|
|
2022-04-21 03:39:37 +00:00
|
|
|
| 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!
|
2022-04-20 23:32:20 +00:00
|
|
|
|
|
|
|
|
|
2022-04-21 17:14:09 +00:00
|
|
|
Screenshots
|
|
|
|
|
===========
|
2022-04-20 23:32:20 +00:00
|
|
|
|
2022-04-21 03:39:37 +00:00
|
|
|
.. figure:: example-definition.png
|
2022-04-20 23:32:20 +00:00
|
|
|
|
2022-04-21 03:39:37 +00:00
|
|
|
An example configuration value is defined.
|
2022-04-20 23:32:20 +00:00
|
|
|
|
2022-04-21 03:39:37 +00:00
|
|
|
.. figure:: example-usage.png
|
|
|
|
|
|
|
|
|
|
The previously defined configuration value is used in the program.
|
|
|
|
|
|
|
|
|
|
.. figure:: example-configuration.png
|
|
|
|
|
|
|
|
|
|
An user configuring the program previews the current configuration.
|
2022-04-20 23:32:20 +00:00
|
|
|
|
|
|
|
|
|
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-22 16:21:53 +00:00
|
|
|
advanced
|
2022-04-20 20:29:40 +00:00
|
|
|
reference
|
2022-04-19 02:09:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Other tables and links
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
