Metadata-Version: 2.1
Name: environ-config
Version: 20.1.0
Summary: Boilerplate-free configuration with env variables.
Home-page: https://github.com/hynek/environ_config
Author: Hynek Schlawack
Author-email: hs@ox.cx
Maintainer: Hynek Schlawack
Maintainer-email: hs@ox.cx
License: MIT
Project-URL: Bug Tracker, https://github.com/hynek/environ-config/issues
Project-URL: Source Code, https://github.com/hynek/environ-config
Keywords: app,config,env,cfg
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: tests
License-File: LICENSE
License-File: NOTICE
License-File: AUTHORS.rst

==============================================================
*environ-config*: Application Configuration With Env Variables
==============================================================

.. image:: https://readthedocs.org/projects/environ-config/badge/?version=stable
   :target: https://environ-config.readthedocs.io/
   :alt: Documentation Status

.. image:: https://github.com/hynek/environ-config/workflows/CI/badge.svg?branch=master
   :target: https://github.com/hynek/environ-config/actions?workflow=CI
   :alt: CI Status

.. image:: https://codecov.io/gh/hynek/environ-config/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/hynek/environ-config
   :alt: Test Coverage

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/ambv/black
   :alt: Code style: black

.. -teaser-begin-

*environ-config* allows you to configure your applications using environment variables – as recommended in `The Twelve-Factor App <https://12factor.net/config>`_ methodology – with elegant, boilerplate-free, and declarative code:

.. code-block:: pycon

  >>> 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'

``AppConfig.from_environ({...})`` is equivalent to the code above, depending on your taste.


Features
========

- Declarative & boilerplate-free.
- Nested configuration from flat environment 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 <https://www.attrs.org/>`_ which gives you data validation and conversion for free.
- Pluggable secrets extraction.
  Ships with:

  * `HashiCorp Vault <https://www.vaultproject.io>`_ support via `envconsul <https://github.com/hashicorp/envconsul>`_.
  * INI files, because secrets in env variables are icky.
- Pass any dictionary into ``environ.to_config(AppConfig, {"your": "config"})`` instead of loading from the environment.
- Built in dynamic help documentation generation via ``environ.generate_help``.

.. -teaser-end-

You can find the full documentation including a step-by-step tutorial on `Read the Docs <https://environ-config.readthedocs.io/>`_.


Project Information
===================

``environ-config`` is released under the `Apache License 2.0 <https://choosealicense.com/licenses/apache-2.0/>`_ license.
It targets Python 2.7, 3.5 and newer, and PyPy.
Development takes place on `GitHub <https://github.com/hynek/environ-config>`_.


Release Information
===================

20.1.0 (2020-03-23)
-------------------


Backward-incompatible changes:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

*none*


Deprecations:
^^^^^^^^^^^^^

*none*


Changes:
^^^^^^^^

- Configurations can be immutable now.
  `#12 <https://github.com/hynek/environ-config/issues/12>`_

`Full changelog <https://github.com/hynek/environ-config/blob/master/CHANGELOG.rst>`_.

Credits
=======

*environ-config* is written and maintained by `Hynek Schlawack <https://hynek.me/>`_ – why not `buy him a coffee <https://ko-fi.com/the_hynek>`_ for all the years of maintenance?

The development is kindly supported by `Variomedia AG <https://www.variomedia.de/>`_.

A full list of contributors can be found in `GitHub's overview <https://github.com/hynek/environ_config/graphs/contributors>`_.

*environ-config* wouldn't be possible without the `attrs project <http://www.attrs.org>`_.


