Metadata-Version: 1.1
Name: confirm
Version: 0.1.3
Summary: Simple Python configuration file management.
Home-page: https://github.com/louib/confirm
Author: Louis-Bertrand Varin
Author-email: louisbvarin@gmail.com
License: MIT
Description: Confirm
        =======
        
        .. image:: https://api.travis-ci.org/louib/confirm.svg
          :target: https://travis-ci.org/louib/confirm
        .. image:: https://img.shields.io/pypi/v/confirm.svg
          :target: https://pypi.python.org/pypi/confirm/
        
        Simple Python configuration file management.
        
        Confirm validates a configuration file (.INI or YAML format) against a YAML
        configuration schema.
        
        Installation
        ------------
        
        .. code:: bash
        
          $ pip install confirm
        
        
        Example schema file
        -------------------
        
        .. code:: yaml
        
          "system":
              "name":
                  "required": true
                  "description": "Name of the system associated with the server."
                  "type": "str"
          "http_server":
              "listen":
                  "required": true
                  "type": "str"
                  "description": "Listening address of the HTTP server."
                  "default": "localhost"
              "port":
                  "required": true
                  "type": "int"
                  "default": 8088
                  "description": "Port of the HTTP server."
          "threading":
              "initial_pool_size":
                  "description": "Initial number of threads in the thread pool."
                  "type": "int"
                  "default": 10
              "maximum_pool_size":
                  "description": "Maximum number of threads in the thread pool."
                  "type": "int"
                  "default": 100
                  "deprecated": true
        
        
        Usage
        -----
        
        .. code:: bash
        
          $ confirm validate examples/confirm.yaml project.conf
          Error   : Missing required section system.
          Error   : Missing required section http_server.
          Warning : Deprecated option maximum_pool_size is present in section threading!
        
        
        Confirm can also be used for validation as a Python library:
        
        .. code:: python
        
          from confirm.validator import validator_from_config_file
          ...
        
            result = validator_from_config_file(config_file_path, schema_file_path)
            result.validate()
            print(result.is_valid())
        
        
        License
        -------
        MIT License.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
