Skip to main content

Interpolate Yaml files with env vars

Project description

Build Status PyPi package

Interpolate YaML files with environmental variables and other YaML files.

Given a YaML string like:

a: ${A}
b: 2

and an environmental variable $A with value hello, yamlenv.load would return:

{
    a: 'hello',
    b: 2
}

Including YAML literals as environment variables is also supported - so if the environment variable $A was set to false, yamlenv.load would return:

{
    a: False,
    b: 2
}

Default values are supported:

yamlenv.load('''
    a: ${A:-hello}
    b: 2
''') == {
    'a': 'hello',
    'b': 2
}

As in Bash, defaulting can be done with either :- (to not allow empty defaults) or with - to allow empty values.

The environmental variable can be embedded in a larger string, too:

yamlenv.load('''
    a: foo ${A:-bar} baz
    b: 2
''') == {
    'a': 'foo bar baz',
    'b': 2
}

More than one environmental variable can appear in a string:

yamlenv.load('''
    a: foo ${A:-bar} ${B:-baz}
    b: 2
''') == {
    'a': 'foo bar baz',
    'b': 2
}

YaML files can include other YaML files, too. E.g. if b.yaml contains “2”, then:

yamlenv.load('''
    a: 1
    b: !include b.yaml
''') == {
    'a': 1
    'b': 2
}

The included YaML file can be as complex as necessary.

More examples are available in the tests.

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

yamlenv-0.7.1.tar.gz (4.9 kB view details)

Uploaded Source

File details

Details for the file yamlenv-0.7.1.tar.gz.

File metadata

  • Download URL: yamlenv-0.7.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3

File hashes

Hashes for yamlenv-0.7.1.tar.gz
Algorithm Hash digest
SHA256 1dd1e73826676686f153411c2fa06fd81524ab3ef7e71f8271828fb40e3d5b3f
MD5 b899a6500fb57c6657573d5c31b19508
BLAKE2b-256 e671f07b6c05aeb376f23b10db873d2a0fba00891e8d37234925c8c486c11761

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