Skip to main content

Hierarchical YAML configuration utility for Python

Project description

yamlcfg
=======

Hierarchical YAML configuration utility for Python

yamlcfg makes it easier to have different levels of YAML configuration files,
with prioritization that you declare, based on the order of the `paths`
keyword argument.

It first checks your environment for the variable, and if it exists, it uses
that over anything else. Then it checks the first file in `paths`, or `path`,
and then the next in order until the variable is found. If not found, it returns
None.

Access is allowed via normal attribute access via the dot operator, or from
an index such as `config['myattr']`.

To dump the full configuration that was loaded back to file (first path in
`paths`), just invoke `write()`.

Example:

from yamlcfg import YamlConfig
config = YamlConfig(path='~/.some_config.yml')
print(config.foo)
config.foo = 'bar'
config.write()

fifo_configs = YamlConfig(paths=
('.myconfig.yml', '~/.userconfig.yml', '/etc/myconfig/defaultconfig.yml')
)
# First checks .myconfig.yml, and if it doesn't exist there, it checks
# ~/.userconfig.yml, and so on. If an environment variable of the same name
# is set, it will use that first.
print(fifo_configs.some_var)
# Dumps to the first path in paths, with every variable it found in order.
fifo_configs.write()

Project details


Download files

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

Source Distribution

yamlcfg-0.5.3.tar.gz (5.2 kB view details)

Uploaded Source

File details

Details for the file yamlcfg-0.5.3.tar.gz.

File metadata

  • Download URL: yamlcfg-0.5.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for yamlcfg-0.5.3.tar.gz
Algorithm Hash digest
SHA256 8240c8ff0e181948d5a5609be92330759f99f01e5cce4a57cded32e50f24b9c4
MD5 1950ba00eabceafe851ea09f7accacb1
BLAKE2b-256 503e300f703e63e5c7aa6bfb51b1ece7d9dd63e20b624299b830bca3a3e62452

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page