Metadata-Version: 1.2
Name: yaml-configuration
Version: 0.2.5
Summary: A python module to easily read from and write to yaml config files.
Home-page: https://github.com/DLR-RM/python-yaml-configuration
Author: Sebastian Brunner
Author-email: sebastian.brunner@dlr.de
Maintainer: Sebastian Brunner
Maintainer-email: sebastian.brunner@dlr.de
License: BSD
Description: 
        yaml\_configuration
        ===================
        
        This module offers easy configuration for a other modules or startup
        scripts. It offers an easy way to load and save config files and read
        and write config values to it. Also trying to read a config value by
        passing an optional default value if the real config value is not
        present is supported.
        
        Usage
        =====
        
        The class DefaultConfig provides the basic functionality of the package.
        A custom configuration class is meant to derive from it.
        
        .. code:: python
        
            import os
            import logging
            from pytest import raises
            from yaml_configuration.config import DefaultConfig, ConfigError
        
        
            def read_file(file_path, filename):
                file_path = os.path.join(file_path, filename)
                with open(file_path, 'r') as file_pointer:
                    file_content = file_pointer.read()
                return file_content
        
        
            class BasicConfig(DefaultConfig):
        
                def __init__(self, config_string, config_file, logger_object=None):
                    super(BasicConfig, self).__init__(config_string, logger_object)
                    # this is already done in the init
                    # self.load(config_file, path=os.path.dirname(__file__))
        
        
            if __name__ == '__main__':
                config_file = "basic_config.yaml"
                config_string = read_file(os.path.dirname(__file__), config_file)
                basic_config = BasicConfig(config_string, config_file, logging.getLogger("TestLogger"))
                basic_config.set_config_value("number_value", 10)
                basic_config.set_config_value("string_value", "test_string")
                assert basic_config.get_config_value("string_value") == "test_string"
                assert basic_config.get_config_value("not_existing_config_value", default=42) == 42
                with raises(ConfigError):
                    if not basic_config.get_config_value("value_that_should_exist"):
                        raise ConfigError("The config value with key 'value_that_should_exist' should exist")
        
        ..
        
        
Keywords: yaml,configuration
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=2.6
