Skip to main content

Boilerplate-free configuration with env variables.

Project description

CI status Test Coverage

environ_config allows you to configure your applications using environment variables – as recommended in The Twelve-Factor App methodology – with elegant, boilerplate-free, and declarative code:

>>> import environ
>>> # Extracts secrets from Vault-via-envconsul: 'secret/your-app':
>>> vault = environ.secrets.VaultEnvSecrets(vault_prefix="SECRET_YOUR_APP")
>>> @environ.config(prefix="APP")
... class AppConfig:
...    @environ.config
...    class DB:
...        name = environ.var("default_db")
...        host = environ.var("default.host")
...        port = environ.var(5432, converter=int)  # Use attrs's converters and validators!
...        user = environ.var("default_user")
...        password = vault.secret()
...
...    env = environ.var()
...    lang = environ.var(name="LANG")  # It's possible to overwrite the names of variables.
...    db = environ.group(DB)
...    awesome = environ.bool_var()
>>> cfg = environ.to_config(
...     AppConfig,
...     environ={
...         "APP_ENV": "dev",
...         "APP_DB_HOST": "localhost",
...         "LANG": "C",
...         "APP_AWESOME": "yes",  # true and 1 work too, everything else is False
...         # Vault-via-envconsul-style var name:
...         "SECRET_YOUR_APP_DB_PASSWORD": "s3kr3t",
... })  # Uses os.environ by default.
>>> cfg
AppConfig(env='dev', lang='C', db=AppConfig.DB(name='default_db', host='localhost', port=5432, user='default_user', password=<SECRET>), awesome=True)
>>> cfg.db.password
's3kr3t'

Features

  • Declarative & boilerplate-free.
  • Nested config from flat env variable names.
  • Default & mandatory values: enforce configuration structure without writing a line of code.
  • Helpful debug logging that will tell you which variables are present and what environ_config is looking for.
  • Built on top of attrs which gives you data validation and conversion for free.
  • Plugable secrets extraction. Ships with:

Project Information

environ_config is released under the MIT license. It targets Python 2.7, 3.5 and newer, and PyPy.

Release Information

18.2.0 (2018-01-12)

Backward-incompatible changes:

  • Use RawConfigParser for ini-style secrets to avoid interpolation errors.

Changes:

none

Full changelog.

Credits

environ_config is written and maintained by Hynek Schlawack.

The development is kindly supported by Variomedia AG.

A full list of contributors can be found in GitHub’s overview.

environ_config wouldn’t be possible without the attrs project.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
environ_config-18.2.0-py2.py3-none-any.whl (9.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3
environ_config-18.2.0.tar.gz (10.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page