Skip to main content

Accessing environment variables with a magic module.

Project description

Accessing environment variables with a magic module.

>>> import os
>>> from envcfg.raw.python import CONFIGURE_OPTS
'--enable-shared --enable-universalsdk=/ --with-universal-archs=intel'

It works with many frameworks such as Django and Flask. Then you can store your config in the environment variables instead of framework-specific config files. It is recommended by 12-Factor.


$ pip install python-envcfg
$ pip freeze > requirements.txt  #


Uses with Flask

  1. Defines environment variables with a prefix:

    $ cat .env  # should not checked into VCS
    # values are valid JSON expressions
  2. Creates Flask app and loads config from python-envcfg:

    $ cat
    app = Flask(__name__)
    app.config.from_object('envcfg.json.myapp')  # MYAPP_ -> .myapp
  3. Enters your app with those environment variables:

    $ (source .env && python

Uses with Django

  1. Creates a django project and moves all sensitive config items into the environment variables:

    $ cat djapp/  # codebase-scope config
    $ cat .env  # environment-scope config, should not checked into VCS
    # values are valid JSON expressions
  2. Adds importing statements in the end of module:

    $ tail -n 2 djapp/
    # importing all config items stored in the environment variables
    from envcfg.json.djapp import *  # noqa
  3. Runs your Django app with environment variables:

    $ (source .env && python runserver)

Works on Projects

In development, we can work with per-project environments but no more typing source foo/bar.

I recommend to put your project-specified environment variables in {PROJECT_ROOT}/.env and mark the .env as ignored in your VCS. For example, you can write /.env in .gitignore if you are using Git, and put a .env.example as a copying template for new-cloned projects.

And then, you can use some utility such as honcho or autoenv to apply the .env automatically.

For honcho:

$ echo 'MYPROJECT_DEBUG=true' >> .env
$ echo 'web: python runserver' >> Procfile
$ honcho run python check-debug
$ honcho start web
Starting development server at

For autoenv:

$ echo 'MYPROJECT_DEBUG=true' >> myproject/.env
$ cd myproject
$ python check-debug
$ python runserver
Starting development server at


If you want to report bugs or request features, please create issues on GitHub Issues.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-envcfg, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size python_envcfg-0.1.0-py2.py3-none-any.whl (5.1 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size python-envcfg-0.1.0.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page