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.1901rc1

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.1901rc1
File Size Uploaded Provenance
envyaml-0.1901rc1.tar.gz 4.0 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 8.1 kB

Release files / envyaml-0.1901rc1.tar.gz

Download URL envyaml-0.1901rc1.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d37d7d9019e88423d587dc97a57437ebbc1c508bec0ba7b0c1d5f9bd78486390
BLAKE2b-256 checksum
How to use checksums
b7a6611a332969d5309597931a3f2fe40ac5fd577f2ca301ae43f80c85c17a77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.2

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

Download URL envyaml-0.1901rc1-py3-none-any.whl
Size 4.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d462990c581920085ad787a2cf3f1a78ffc92bc43f41f273fb44291b6542804
BLAKE2b-256 checksum
How to use checksums
028741b5ed12cad3b09229b4845b741dbfcd9f9fe78520f6862ca1da6688220a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.2

Security for envyaml 0.1901rc1

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