Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

EnvYAML | Build Status Coverage Status

Simple YAML configuration file parser with easy access for structured data

Why

Modern configuration file become to be more complex, flexible and readable. YAML file format are perfect to store configuration file but had no option to pass environment variables. This project try to simplify usage YAML file and environment variables as program configuration file with easy config key access.

Basic usage

Let's assume we had a project with this config file env.yaml

# env.yaml
database:
    host: $DATABASE_HOST
    port: 3301
    username: username
    password: $DATABASE_PASSWORD
    database: test

    table:
      user: table_user
      blog: table_blog

redis:
    host: $REDIS_HOST
    port: 5040

    config:
      expire: 300
      prefix: $REDIS_PREFIX

and environment variables set to

$DATABASE_HOST=xxx.xxx.xxx.xxx
$DATABASE_PASSWORD=super-secret-password
$REDIS_PREFIX=state

parse file with EnvYAML

from envyaml import EnvYAML

# read file env.yaml and parse config
env = EnvYAML('env.yaml')

# access whole database section
print(env.database)

# {
# 'database': 'test',
# 'host': 'xxx.xxx.xxx.xxx',
# 'password': 'super-secret-password',
# 'port': 3301,
# 'table':
#   {
#       'blog': 'table_blog', 
#       'user': 'table_user'
#   },
# 'username': 'username'
# }

# access database host value as properties name
print(env.database__host)

# >> xxx.xxx.xxx.xxx

# access database user table value as properties name
print(env.database__table__user)

# >> table_user

access config parameters with key option ['name']

print(env['database__port'])
# >> 3301

access config with get function and default value

print(env.get('not__exist__value', 'default'))
# >> default

License

MIT licensed. See the LICENSE file for more details.

Metadata

Release files for envyaml 0.1901rc4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for envyaml 0.1901rc4
File Size Uploaded Provenance
envyaml-0.1901rc4.tar.gz 4.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for envyaml 0.1901rc4
File Interpreter ABI Platform
envyaml-0.1901rc4-py3-none-any.whl Python 3 none any Details

Total release size: 9.5 kB

Release files / envyaml-0.1901rc4.tar.gz

Download URL envyaml-0.1901rc4.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
24a543b543889277e95dba607e89c8146211b4ab7b4c73077cdfbc67c4e93d7c
BLAKE2b-256 checksum
How to use checksums
4bb1412a2c356aa7087ce5e56fefb5a7c6bf3cc0a79d716158ae450eeeb92f2e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

Release files / envyaml-0.1901rc4-py3-none-any.whl

Download URL envyaml-0.1901rc4-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a1502f686dfa84a8ae43c08fc489903a826f778821373104af817bd466df88f
BLAKE2b-256 checksum
How to use checksums
d9738a91761f2f26c35eb7bd24ef4e0f59b75efcfaf070b32c452b43bf99420f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

Security for envyaml 0.1901rc4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page