Metadata-Version: 2.1
Name: django-getenv
Version: 1.3.2
Summary: Read settings from environment variables.
Home-page: http://github.com/schwuk/django-getenv
Author: David Murphy
Author-email: dave@schwuk.com
License: BSD
Keywords: django-getenv
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
License-File: LICENSE
License-File: AUTHORS.rst

=============
django-getenv
=============

.. image:: https://badge.fury.io/py/django-getenv.svg
    :target: https://pypi.python.org/pypi/django-getenv
    
.. image:: https://travis-ci.org/schwuk/django-getenv.png?branch=master
    :target: https://travis-ci.org/schwuk/django-getenv
        
.. image:: https://landscape.io/github/schwuk/django-getenv/master/landscape.png
    :target: https://landscape.io/github/schwuk/django-getenv/master
    :alt: Code Health

A quick'n'easy way to use environment variables in your Django (and
Python) projects.

* Free software: BSD license

Introduction
------------

If you're using
`django-dotenv <https://github.com/jacobian/django-dotenv>`__ to get the
most out of your ``.env`` file, you want to use the values there in your
`Django <https://www.djangoproject.com/>`__ project's settings.

It will convert boolean, integer and float values to their native Python
types.

There's nothing here that is Django specific, but I'm using it with
Django so that's what I've called it.

Installation
------------

::

    pip install django-getenv

Usage
-----

In your ``settings.py`` file (or equivalent), add:

::

    from getenv import env

Then to read in your environment variables, do this:

::

    SECRET_KEY = env("SECRET_KEY")

If you want to provide a default (in case the environment variable isn't
set), try:

::

    SECRET_KEY = env("SECRET_KEY", "a_secret_key")

You can also use getenv in a template:

::
    {% load getenv %}

    Current path: {% getenv "PATH" %}


For best results, mix with
`django-dotenv <https://github.com/jacobian/django-dotenv>`__ and
`dj-database-url <https://github.com/kennethreitz/dj-database-url>`__.




History
-------

1.3.2 (2017-04-15)
++++++++++++++++++

* Use custom ImproperlyConfigured instead of Django's (#5)

1.3.1 (2014-03-07)
++++++++++++++++++

* Fix HISTORY.rst
* Remove Python 2.6 from Travis configuration

1.3.0 (2014-03-06)
++++++++++++++++++

* Improved (cookiecutter-pypackage style) project layout

1.2.0 (2014-01-14)
++++++++++++++++++

* Specify an environment variable as required, and raise ImproperlyConfigured 
  exception if not present (#2)

1.1.0 (2013-07-24)
++++++++++++++++++

* Marked as "5 - Production/Stable" instead of "4 - Beta"
* Cleaned up README
* Added CHANGES

1.0.0 (2013-07-19)
++++++++++++++++++

* Initial release


