envbash 1.0.0

Source env.bash script to update environment

Python module for sourcing a bash script to augment the environment. Supports Python 2.7 and 3.3+

Rationale

[12-factor apps](https://12factor.net/) require [configuration loaded from the environment](https://12factor.net/config).

That’s easy on a platform like Heroku, where the environment is preset by the user with [commands like heroku config:set](https://devcenter.heroku.com/articles/config-vars). But it’s messier in development and non-Heroku deployments, where the environment might need to be loaded from a file.

This package provides a mechanism for sourcing a Bash script to update Python’s environment (os.environ). There are reasons for using a Bash script instead of another configuration language:

1. Environment variable keys and values should always be strings. Using a Bash script to update the environment enforces that restriction, so there won’t be surprises when you deploy into something like Heroku later on.

2. Using a script means that the values can be sourced into a Bash shell, something that’s non-trivial if you use a different config language.

3. For better or worse, using a script means that environment variables can be set using the full power of the shell, including reading from other files.

Commonly the external file is called env.bash, hence the name of this project.

Installation

Install from PyPI:

pip install envbash

Usage

Call load_envbash to source a Bash script into the current Python process. Any variables that are set in the script, regardless of whether they are explicitly exported, will be added to the process environment.

For example, given env.bash with the following content:

FOO='bar baz qux'

This can be loaded into Python:

import os
from envbash import load_envbash

load_envbash('env.bash')

print(os.environ['FOO'])  #=> prints BAR

Legal

Copyright 2017 Scampersand LLC

Released under the MIT license