django-environ-plus 0.0.3

Django-environ-plus allows you to utilize 12factor inspired environment variables to configure your Django application.

Django-environ-plus

Django-environ-plus allows you to utilize 12factor inspired environment variables to configure your Django application.

|pypi| |unix_build| |windows_build| |coverage| |downloads| |license|

This module is a merge of:

• envparse_
• honcho_
• dj-database-url_
• dj-search-url_
• dj-config-url_
• django-cache-url_

and inspired by:

• 12factor_
• 12factor-django_
• Two Scoops of Django_

This is your settings.py file before you have installed django-environ-plus

.. code-block:: python

import os
SITE_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))

DEBUG = True
TEMPLATE_DEBUG = DEBUG

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'database',
        'USER': 'user',
        'PASSWORD': 'githubbedpassword',
        'HOST': '127.0.0.1',
        'PORT': '8458',
    }
    'extra': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(SITE_ROOT, 'database.sqlite')
    }
}

MEDIA_ROOT = os.path.join(SITE_ROOT, 'assets')
MEDIA_URL = 'media/'
STATIC_ROOT = os.path.join(SITE_ROOT, 'static')
STATIC_URL = 'static/'

SECRET_KEY = '...im incredibly still here...'

CACHES = {
    'default': {
        'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
        'LOCATION': [
            '127.0.0.1:11211', '127.0.0.1:11212', '127.0.0.1:11213',
        ]
    },
    'redis': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': '127.0.0.1:6379:1',
        'OPTIONS': {
            'CLIENT_CLASS': 'django_redis.client.DefaultClient',
            'PASSWORD': 'redis-githubbed-password',
        }
    }
}

After:

.. code-block:: python

import environ
root = environ.Path(__file__) - 3 # three folder back (/a/b/c/ - 3 = /)
env = environ.Env(DEBUG=(bool, False),) # set default values and casting
environ.Env.read_env() # reading .env file

SITE_ROOT = root()

DEBUG = env('DEBUG') # False if not in os.environ
TEMPLATE_DEBUG = DEBUG

DATABASES = {
    'default': env.db(), # Raises ImproperlyConfigured exception if DATABASE_URL not in os.environ
    'extra': env.db('SQLITE_URL', default='sqlite:////tmp/my-tmp-sqlite.db')
}

public_root = root.path('public/')

MEDIA_ROOT = public_root('media')
MEDIA_URL = 'media/'
STATIC_ROOT = public_root('static')
STATIC_URL = 'static/'

SECRET_KEY = env('SECRET_KEY') # Raises ImproperlyConfigured exception if SECRET_KEY not in os.environ

CACHES = {
    'default': env.cache(),
    'redis': env.cache('REDIS_URL')
}

You can also pass read_env() an explicit path to the .env file.

Create a .env file:

.. code-block:: bash

DEBUG=on
# DJANGO_SETTINGS_MODULE=myapp.settings.dev
SECRET_KEY=your-secret-key
DATABASE_URL=psql://urser:un-githubbedpassword@127.0.0.1:8458/database
# SQLITE_URL=sqlite:///my-local-sqlite.db
CACHE_URL=memcache://127.0.0.1:11211,127.0.0.1:11212,127.0.0.1:11213
REDIS_URL=rediscache://127.0.0.1:6379:1?client_class=django_redis.client.DefaultClient&password=redis-un-githubbed-password

How to install

::

$ pip install django-environ-plus

How to use

There are only two classes, environ.Env and environ.Path

.. code-block:: python

>>> import environ
>>> env = environ.Env(
        DEBUG=(bool, False),
    )
>>> env('DEBUG')
False
>>> env('DEBUG', default=True)
True

>>> open('.myenv', 'a').write('DEBUG=on')
>>> environ.Env.read_env('.myenv') # or env.read_env('.myenv')
>>> env('DEBUG')
True

>>> open('.myenv', 'a').write('\nINT_VAR=1010')
>>> env.int('INT_VAR'), env.str('INT_VAR')
1010, '1010'

>>> open('.myenv', 'a').write('\nDATABASE_URL=sqlite:///my-local-sqlite.db')
>>> env.read_env('.myenv')
>>> env.db()
{'ENGINE': 'django.db.backends.sqlite3', 'NAME': 'my-local-sqlite.db', 'HOST': '', 'USER': '', 'PASSWORD': '', 'PORT': ''}

>>> root = env.path('/home/myproject/')
>>> root('static')
'/home/myproject/static'

Supported Types

• str
• bool
• int
• float
• json
• list (FOO=a,b,c)
• tuple (FOO=(a,b,c))
• dict (BAR=key=val,foo=bar) #environ.Env(BAR=(dict, {}))
• dict (BAR=key=val;foo=1.1;baz=True) #environ.Env(BAR=(dict(value=unicode, cast=dict(foo=float,baz=bool)), {}))
• url
• path (environ.Path)
• db_url
  • PostgreSQL: postgres://, pgsql://, psql:// or postgresql://
  • PostGIS: postgis://
  • MySQL: mysql:// or mysql2://
  • MySQL for GeoDjango: mysqlgis://
  • SQLITE: sqlite://
  • SQLITE with SPATIALITE for GeoDjango: spatialite://
  • Oracle: oracle://
  • LDAP: ldap://
• cache_url
  • Database: dbcache://
  • Dummy: dummycache://
  • File: filecache://
  • Memory: locmemcache://
  • Memcached: memcache://
  • Python memory: pymemcache://
  • Redis: rediscache://
• search_url
  • ElasticSearch: elasticsearch://
  • Solr: solr://
  • Whoosh: whoosh://
  • Xapian: xapian://
  • Simple cache: simple://
• email_url
  • SMTP: smtp://
  • SMTP+SSL: smtp+ssl://
  • SMTP+TLS: smtp+tls://
  • Console mail: consolemail://
  • File mail: filemail://
  • LocMem mail: memorymail://
  • Dummy mail: dummymail://

Tips

Using unsafe characters in URLs

In order to use unsafe characters you have to encode with urllib.parse.encode before you set into .env file.

.. code-block::

DATABASE_URL=mysql://user:%23password@127.0.0.1:3306/dbname

See https://perishablepress.com/stop-using-unsafe-characters-in-urls/ for reference.

Email settings

In order to set email configuration for django you can use this code:

.. code-block:: python

EMAIL_CONFIG = env.email_url(
    'EMAIL_URL', default='smtp://user@:password@localhost:25')

vars().update(EMAIL_CONFIG)

Tests

::

$ git clone [e-mail]:joke2k/django-environ.git
$ cd django-environ/
$ python setup.py test

License

Django-environ-plus is licensed under the MIT License - see the LICENSE_ file for details

Changelog

0.0.3 - 12-September-2019`

• Updated environ

0.0.2 - 18-February-2019`

• Support for cache django 2.1

0.0.1 - 18-February-2019`

• Fixes of fedt and prepare the pypi package
• Moved to gitlab

0.4.1 - 13-November-2016 <https://github.com/joke2k/django-environ/compare/v0.4...v0.4.1>__

• Fix for unsafe characters into URLs
• Clarifying warning on missing or unreadable file. Thanks to @nickcatal
• Add support for Django 1.10.
• Fix support for Oracle urls
• Fix support for django-redis

0.4.0 - 23-September-2015 <https://github.com/joke2k/django-environ/compare/v0.3...v0.4>__

• Fix non-ascii values (broken in Python 2.x)
• New email schemes - smtp+ssl and smtp+tls (smtps would be deprecated)
• redis_cache replaced by django_redis
• Add tuple support. Thanks to @anonymouzz
• Add LDAP url support for database (django-ldapdb)
• Fix psql/pgsql url

0.3 - 03-June-2014 <https://github.com/joke2k/django-environ/compare/v0.2.1...v0.3>__

• Add cache url support
• Add email url support
• Add search url support
• Rewriting README.rst

0.2.1 19-April-2013

• environ/environ.py: Env.call now uses Env.get_value instance method

0.2 16-April-2013

• environ/environ.py, environ/test.py, environ/test_env.txt: add advanced float parsing (comma and dot symbols to separate thousands and decimals)
• README.rst, docs/index.rst: fix TYPO in documentation

0.1 02-April-2013

• initial release

Credits

• 12factor_
• 12factor-django_
• Two Scoops of Django_
• rconradharris_ / envparse_
• kennethreitz_ / dj-database-url_
• migonzalvar_ / dj-email-url_
• ghickman_ / django-cache-url_
• dstufft_ / dj-search-url_
• julianwachholz_ / dj-config-url_
• nickstenning_ / honcho_
• envparse_
• Distribute_
• modern-package-template_

.. _rconradharris: https://github.com/rconradharris .. _envparse: https://github.com/rconradharris/envparse

.. _kennethreitz: https://github.com/kennethreitz .. _dj-database-url: https://github.com/kennethreitz/dj-database-url

.. _migonzalvar: https://github.com/migonzalvar .. _dj-email-url: https://github.com/migonzalvar/dj-email-url

.. _ghickman: https://github.com/ghickman .. _django-cache-url: https://github.com/ghickman/django-cache-url

.. _julianwachholz: https://github.com/julianwachholz .. _dj-config-url: https://github.com/julianwachholz/dj-config-url

.. _dstufft: https://github.com/dstufft .. _dj-search-url: https://github.com/dstufft/dj-search-url

.. _nickstenning: https://github.com/nickstenning .. _honcho: https://github.com/nickstenning/honcho

.. _12factor: http://www.12factor.net/ .. _12factor-django: http://www.wellfireinteractive.com/blog/easier-12-factor-django/ .. _Two Scoops of Django: http://twoscoopspress.org/

.. _Distribute: http://pypi.python.org/pypi/distribute .. _modern-package-template: http://pypi.python.org/pypi/modern-package-template

.. |pypi| image:: https://img.shields.io/pypi/v/django-environ.svg?style=flat-square&label=version :target: https://pypi.python.org/pypi/django-environ :alt: Latest version released on PyPi

.. |coverage| image:: https://img.shields.io/coveralls/joke2k/django-environ/master.svg?style=flat-square :target: https://coveralls.io/r/joke2k/django-environ?branch=master :alt: Test coverage

.. |unix_build| image:: https://img.shields.io/travis/joke2k/django-environ/master.svg?style=flat-square&label=unix%20build :target: http://travis-ci.org/joke2k/django-environ :alt: Build status of the master branch on Mac/Linux

.. |windows_build| image:: https://img.shields.io/appveyor/ci/joke2k/django-environ.svg?style=flat-square&label=windows%20build :target: https://ci.appveyor.com/project/joke2k/django-environ :alt: Build status of the master branch on Windows

.. |downloads| image:: https://img.shields.io/pypi/dm/django-environ.svg?style=flat-square :target: https://pypi.python.org/pypi/django-environ :alt: Monthly downloads

.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square :target: https://raw.githubusercontent.com/joke2k/django-environ/master/LICENSE.txt :alt: Package license

.. _LICENSE: https://github.com/joke2k/django-environ/blob/master/LICENSE.txt