Skip to content

Commit

Permalink
clean pipy description, add 'How to install' section to README and do…
Browse files Browse the repository at this point in the history
…cs, and switch to version 0.2.1
  • Loading branch information
joke2k committed Apr 17, 2013
1 parent bdcfdd4 commit 156b934
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ develop-eggs
tmp
build
dist

docs/_build
10 changes: 10 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ After::

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

How to install
--------------

::
$ pip install django-environ


DevMode
-------
Expand Down Expand Up @@ -91,6 +97,10 @@ Tests
Changelog
---------

=== 0.2.1 (2013-04-19) ===

* environ/environ.py: Env.__call__ now uses Env.get_value instance method

=== 0.2 (2013-04-16) ===

* environ/environ.py, environ/test.py, environ/test_env.txt: add advanced
Expand Down
17 changes: 17 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@ Welcome to Django-environ's documentation!

.. automodule:: environ.environ

This module is a merge of:

* https://github.com/rconradharris/envparse
* https://github.com/kennethreitz/dj-database-url
* https://github.com/nickstenning/honcho

and inspired by:

* http://www.12factor.net/
* http://www.wellfireinteractive.com/blog/easier-12-factor-django/
* https://django.2scoops.org (book)

This is your `settings.py` file before you have installed **django-environ**::

import os
Expand Down Expand Up @@ -56,6 +68,11 @@ After::

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

How to install
--------------
::

pip install django-environ

DevMode
-------
Expand Down
15 changes: 1 addition & 14 deletions environ/environ.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,6 @@
"""
Django-environ allows you to utilize 12factor inspired environment
variables to configure your Django application.
This module is a merge of:
* https://github.com/rconradharris/envparse
* https://github.com/kennethreitz/dj-database-url
* https://github.com/nickstenning/honcho
and inspired by:
* http://www.12factor.net/
* http://www.wellfireinteractive.com/blog/easier-12-factor-django/
* https://django.2scoops.org (book)
"""
import os
import re
Expand All @@ -35,7 +22,7 @@ class ImproperlyConfigured(Exception):


__author__ = 'joke2k'
__version__ = (0, 2)
__version__ = (0, 2, 1)


class Env(object):
Expand Down

0 comments on commit 156b934

Please sign in to comment.