Metadata-Version: 2.1
Name: configdict
Version: 2.9.0
Summary: A supercharged dict used as configuration
Author-email: Eduardo Moguillansky <eduardo.moguillansky@gmail.com>
License: Copyright (c) 2011-2017 GitHub Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining
        a copy of this software and associated documentation files (the
        "Software"), to deal in the Software without restriction, including
        without limitation the rights to use, copy, modify, merge, publish,
        distribute, sublicense, and/or sell copies of the Software, and to
        permit persons to whom the Software is furnished to do so, subject to
        the following conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
        LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
        OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
        WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://github.com/gesellkammer/configdict
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.md
Requires-Dist: setuptools
Requires-Dist: appdirs
Requires-Dist: PyYAML
Requires-Dist: watchdog
Requires-Dist: fuzzywuzzy

configdict
==========

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

https://configdict.readthedocs.io


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


    $ pip install configdict



CheckedDict
-----------

A dictionary based on a default prototype. A CheckedDict can only define
``key:value`` pairs which are already present in the default. It is possible to
define a docstring for each key and different restrictions for the values
regarding possible values, ranges and type. A CheckedDict is useful for
configuration settings.


ConfigDict
----------

Based on CheckedDict, a ConfigDict is a persistent, unique dictionary. It is
saved under the config folder determined by the OS and it is updated with each
modification. It is useful for implementing configuration of a module / library
/ app, where there is a default/initial state and the user needs to be able to
configure global settings which must be persisted between sessions (similar to
the settings in an application)

Example
-------

.. code-block:: python

   config = ConfigDict("myproj.subproj")
   config.addKey("keyA", 10, doc="documentaion of keyA")
   config.addKey("keyB", 0.5, range=(0, 1))
   config.addKey("keyC", "blue", choices=("blue", "red"),
                 doc="documentation of keyC")
   config.load()

Alternatively, a ConfigDict can be created all at once:

.. code-block:: python
                
   config = ConfigDict("myapp",
       default = {
           'font-size': 10.0,
           'font-family': "Monospace",
           'port' : 9100,
       },
       validator = {
           'font-size::range' : (8, 24),
           'port::range' : (9000, 65000),
           'font-family::choices' : {'Roboto', 'Monospace'},
       },
       docs = {
           'port': 'The port number to listen to',
           'font-size': 'The size of the font, in pixels'
       }
   )

This will create the dictionary and load any persisted version. Any saved
modifications will override the default values. Whenever the user changes any
value (via ``config[key] = newvalue``) the dictionary will be saved.

In all other respects a ConfigDict behaves like a normal dictionary.
