EnvYAML |

Simple YAML configuration file parser with easy access for structured data

Why

Modern configuration file become to be more and more complex, flexible and readable. YAML file format are perfect to store configuration, but had no option to pass environment variables. They give flexibility, readability and provide option to store complex data structure. This project aim to simplify usage of the YAML file and environment variables as program configuration file with easy config key access.

Install

pip install envyaml

Basic usage

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

# env.yaml
project:
  name: "${PROJECT_NAME}-${PROJECT_ID}"

database:
    host: $DATABASE_HOST
    port: 3301
    username: username
    password: $DATABASE_PASSWORD
    database: test

    table:
      user: table_user
      blog: table_blog

    query: |-
      SELECT * FROM "users" WHERE "user" = $1 AND "login" = $2 AND "pwd" = $3

    insert: |-
      INSERT INTO "{table}" (user, login) VALUES ($1, $2)

redis:
    host: $REDIS_HOST|127.0.0.1
    port: 5040
    db: $REDIS_DB|3 # with default value

    config:
      expire: 300
      prefix: $REDIS_PREFIX

empty_env: $NOT_EXIST_ENV_VARIABLE

Environment variables set to

PROJECT_NAME=simple-hello
PROJECT_ID=42
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 project name
print(env['project.name'])

# >> simple-hello-42

# 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 key item
print(env['database.host'])

# >> xxx.xxx.xxx.xxx

# access database user table value as key item
print(env['database.table.user'])

# >> table_user

# get sql query with $1,$2,$3 variables
print(env['database.query'])

# >> SELECT * FROM "users" WHERE "user" = $1 AND "login" = $2 AND "pwd" = $3

# using default values if variable not defined
# one example is redis host and redis port, when $REDIS_HOST not set then default value will be used
print(env['redis.host'])

# >> 127.0.0.1

# one example is redis host and redis port, when $REDIS_DB not set then default value will be used
print(env['redis.db'])

# >> 3

# access list items by number
print(env['list_test'][0])

# >> one

# access list items by number as key
print(env['list_test.1'])

# >> two

# test if you have key
print('redis.port' in env)

# >> True

Access config with get function and default value

print(env.get('not.exist.value', 'default'))
# >> default

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

print(env['empty_env'])
# >> None

Use format function to update placeholder

print(env.format('database.insert', table="users"))
# >> INSERT INTO "users" (user, login) VALUES ($1, $2)

Strict mode

This mode is enable by default and prevent from declaring variables that not exist in environment variables or .env file. This leads to have runtime ValueError exception when variables not define with message Strict mode enabled, variable $VAR not defined!. To disable strict mode specify strict=False to EnvYAML object

License

MIT licensed. See the LICENSE file for more details.

Metadata

Release files for envyaml 1.3.201225

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 1.3.201225
File	Size	Uploaded	Provenance
envyaml-1.3.201225.tar.gz	9.7 kB	Dec 24, 2020	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for envyaml 1.3.201225
File	Interpreter	ABI	Platform	Reset
envyaml-1.3.201225-py2.py3-none-any.whl 9.7 kB Dec 24, 2020 Without provenance	Python 2, Python 3	none	any	Details

Total release size: 19.4 kB

Release files / envyaml-1.3.201225.tar.gz

Download URL	envyaml-1.3.201225.tar.gz
Size	9.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`909f781cd53c9aca3c874ca1d994378b09d5c70b307a9a614fec7b7b333adde8`
BLAKE2b-256 checksum How to use checksums	`8b3c09a58bd143fe6bb69570b18bde735c075ef81d35916c1a8e507ba21098a5`
Upload date	Dec 24, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6`

Release files / envyaml-1.3.201225-py2.py3-none-any.whl

Download URL	envyaml-1.3.201225-py2.py3-none-any.whl
Size	9.7 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`de18490b924e50cf39c78b532f348ac38202eee5611a3581554f8c3fe61631b5`
BLAKE2b-256 checksum How to use checksums	`f9cc84a8b5486892c3d2048d29c4c6b1472f93919b8bc79d93a5840bb0db133f`
Upload date	Dec 24, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.6`

Security for envyaml 1.3.201225

Report project as malware

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.