Skip to content

EM51641/PyYAMEL-object

Repository files navigation

Simplify how you read configuration files using PyYAML

codecov Code style: black PyPI Python Unit Tests

Installation

The library is available on PyPI and can be installed using pip:

pip install pyaml-object

Usage

Having a service.yaml file such:

service:
    version: 1.0.0
    name: myservice
    secret_key: XXXXXX

We can read the config file through the Config API by applying the read method.

from pyyaml_object import Config
conf_manager = Config('service.yaml')
conf = conf_manager.read()

Now we have a conf object that embedes every key and value from our yaml file. For instance, we can reconstitute a constant SETTING variable such:

SETTINGS = {
    'VERSION': conf.service.version,
    'NAME': conf.service.name,
    'SECRET_KEY': conf.service.secret_key
}

print(SETTINGS)
#{'VERSION': '1.0.0', 'NAME': 'myservice', 'SECRET_KEY': 'XXXXXX'}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors