Skip to main content

🐱Make more easy for reading/validating/updating config for python app

Project description

CatConfig

PyPI - Python Version PyPI - License test

🐱Make more easy for reading/validating/updating config for python app

Install

pip install catconfig

If you want to use validation feature, install cerberus module for your project to use it normally.

Install toml or pyyaml module for toml/yaml format parsing.

Quickstart

# Example.py
from catconfig import CatConfig, ValidationError

# Load
# Load config from string
c = CatConfig()
c.load_from_string("""
{
    "foo": "bar"
}
""")
# Load config when initalizing CatConfig object
c = CatConfig(data={
    'foo': 'bar'
})
# load config from file
c = CatConfig()
c.load_from_file('./tests/assests/test.json')
# Specify config type when initalizing CatConfig object
c = CatConfig(format='json')
c.load_from_file('./tests/assests/test.json')
# Specify config type when loading config file
c = CatConfig()
c.load_from_file('./tests/assests/test.json', format='json')

# Get item
print(c.foo)
# Print: bar
print(bool(c.some.value.does.nt.exists))
# Print: False
print(str(c.some.value.does.nt.exists))
# Print: None
print(c['foo'])
# Print: bar
print(c.get('foo'))
# Print: bar

# Validation
# visit https://docs.python-cerberus.org/en/stable/usage.html for more info of schema
schema = {
    'foo': {
        'type': 'integer'
    },
    'some_field': {
        'type': 'string'
    }
}
c = CatConfig(validator_schema=schema)
try:
    c.load_from_file('./tests/assests/test.json')
except ValidationError as err:
    print(err.message)
    # Print:
    # arr: unknown field
    # foo: must be of integer type

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for catconfig, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size catconfig-0.1.1-py3-none-any.whl (4.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size catconfig-0.1.1.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page