python-dotenv 0.8.1

Add .env support to your django/flask apps in development and deployments

::

_______ .__ __. ____ ____
| ____|| \ | | \ \ / /
| |__ | \| | \ \/ /
| __| | . ` | \ /
__ | |____ | |\ | \ /
(__)|_______||__| \__| \__/


python-dotenv | |Build Status| |Coverage Status| |PyPI version| |PyPI|
======================================================================

Reads the key,value pair from ``.env`` file and adds them to environment
variable. It is great for managing app settings during development and in
production using `12-factor <http://12factor.net/>`__ principles.

Do one thing, do it well!

- `Usages <#usages>`__
- `Installation <#installation>`__
- `Command-line interface <#command-line-interface>`__
- `iPython Support <#ipython-support>`__
- `Setting config on remote servers <#setting-config-on-remote-servers>`__
- `Related Projects <#related-projects>`__
- `Contributing <#contributing>`__
- `Changelog <#changelog>`__

Usages
======
The easiest and most common usage consists on calling ``load_dotenv`` when the
application starts, which will load environment variables from a file named
``.env`` in the current directory or any of its parents or from the path specificied;
after that, you can just call the environment-related method you need as
provided by ``os.getenv``.

``.env`` looks like this:

.. code:: shell

# a comment and that will be ignored.
REDIS_ADDRESS=localhost:6379
MEANING_OF_LIFE=42
MULTILINE_VAR="hello\nworld"

You can optionally prefix each line with the word ``export``, which will
conveniently allow you to source the whole file on your shell.

``.env`` can interpolate variables using POSIX variable expansion, variables
are replaced from the environment first or from other values in the ``.env``
file if the variable is not present in the environment. (``Note``: Default Value
Expansion is not supported as of yet, see `#30 <https://github.com/theskumar/python-dotenv/pull/30#issuecomment-244036604>`__.)

.. code:: shell

CONFIG_PATH=${HOME}/.config/foo
DOMAIN=example.org
EMAIL=admin@${DOMAIN}


Getting started
================

Assuming you have created the ``.env`` file along-side your settings
module.

::

.
├── .env
└── settings.py

Add the following code to your ``settings.py``

.. code:: python

# settings.py
from dotenv import load_dotenv
load_dotenv()

# OR, the same with increased verbosity:
load_dotenv(verbose=True)

# OR, explicitly providing path to '.env'
from pathlib import Path # python3 only
env_path = Path('.') / '.env'
load_dotenv(dotenv_path=env_path)


At this point, parsed key/value from the `.env` file is now present as system
environment variable and they can be conveniently accessed via ``os.getenv()``

.. code:: python

# settings.py
import os
SECRET_KEY = os.getenv("EMAIL")
DATABASE_PASSWORD = os.getenv("DATABASE_PASSWORD")


``load_dotenv`` do not override existing System environment variables. To override, pass ``override=True`` to ``load_dotenv()``.

You can use ``find_dotenv()`` method that will try to find a ``.env`` file by
(a) guessing where to start using ``__file__`` or the working directory -- allowing this to work in non-file contexts such as IPython notebooks and the REPL, and then
(b) walking up the directory tree looking for the specified file -- called ``.env`` by default.

.. code:: python

from dotenv import load_dotenv, find_dotenv
load_dotenv(find_dotenv())


In-memory filelikes
-------------------

It is possible to not rely on the filesystem to parse filelikes from other sources
(e.g. from a network storage). ``load_dotenv`` and ``dotenv_values`` accepts a filelike ``stream``.
Just be sure to rewind it before passing.

.. code:: python

>>> from io import StringIO # Python2: from StringIO import StringIO
>>> from dotenv import dotenv_values
>>> filelike = StringIO('SPAM=EGSS\n')
>>> filelike.seek(0)
>>> parsed = dotenv_values(stream=filelike)
>>> parsed['SPAM']
'EGSS'


The returned value is dictionary with key value pair.

``dotenv_values`` could be useful if you need to *consume* the envfile but not *apply* it
directly into the system environment.


Django
------

If you are using django you should add the above loader script at the
top of ``wsgi.py`` and ``manage.py``.


Installation
============

::

pip install -U python-dotenv


iPython Support
---------------

You can use dotenv with iPython. You can either let the dotenv search for .env with `%dotenv` or provide the path to .env file explicitly, see below for usages.

::

%load_ext dotenv

# Use find_dotenv to locate the file
%dotenv

# Specify a particular file
%dotenv relative/or/absolute/path/to/.env

# Use _-o_ to indicate override of existing variables
%dotenv -o

# Use _-v_ to turn verbose mode on
%dotenv -v


Command-line interface
======================

For commandline support, use the `cli` option during installation:

::

pip install -U "python-dotenv[cli]"


A cli interface ``dotenv`` is also included, which helps you manipulate
the ``.env`` file without manually opening it. The same cli installed on
remote machine combined with fabric (discussed later) will enable you to
update your settings on remote server, handy isn't it!

::

Usage: dotenv [OPTIONS] COMMAND [ARGS]...

This script is used to set, get or unset values from a .env file.

Options:
-f, --file PATH Location of the .env file, defaults to .env
file in current working directory.
-q, --quote [always|never|auto]
Whether to quote or not the variable values.
Default mode is always. This does not affect
parsing.
--help Show this message and exit.

Commands:
get Retrive the value for the given key.
list Display all the stored key/value.
set Store the given key/value.
unset Removes the given key.


Setting config on remote servers
--------------------------------

We make use of excellent `Fabric <http://www.fabfile.org/>`__ to
acomplish this. Add a config task to your local fabfile, ``dotenv_path``
is the location of the absolute path of ``.env`` file on the remote
server.

.. code:: python

# fabfile.py

import dotenv
from fabric.api import task, run, env

# absolute path to the location of .env on remote server.
env.dotenv_path = '/opt/myapp/.env'

@task
def config(action=None, key=None, value=None):
'''Manage project configuration via .env

e.g: fab config:set,<key>,<value>
fab config:get,<key>
fab config:unset,<key>
fab config:list
'''
run('touch %(dotenv_path)s' % env)
command = dotenv.get_cli_string(env.dotenv_path, action, key, value)
run(command)

Usage is designed to mirror the heroku config api very closely.

Get all your remote config info with ``fab config``

::

$ fab config
foo="bar"

Set remote config variables with ``fab config:set,<key>,<value>``

::

$ fab config:set,hello,world

Get a single remote config variables with ``fab config:get,<key>``

::

$ fab config:get,hello

Delete a remote config variables with ``fab config:unset,<key>``

::

$ fab config:unset,hello

Thanks entirely to fabric and not one bit to this project, you can chain
commands like so ``fab config:set,<key1>,<value1> config:set,<key2>,<value2>``

::

$ fab config:set,hello,world config:set,foo,bar config:set,fizz=buzz


Related Projects
=================

- `Honcho <https://github.com/nickstenning/honcho>`__ - For managing
Procfile-based applications.
- `django-dotenv <https://github.com/jpadilla/django-dotenv>`__
- `django-environ <https://github.com/joke2k/django-environ>`__
- `django-configuration <https://github.com/jezdez/django-configurations>`__
- `dump-env <https://github.com/sobolevn/dump-env>`__

Contributing
============

All the contributions are welcome! Please open `an
issue <https://github.com/theskumar/python-dotenv/issues/new>`__ or send
us a pull request.

This project is currently maintained by `Saurabh Kumar`_ and
would not have been possible without the support of these `awesome people <https://github.com/theskumar/python-dotenv/graphs/contributors>`__.

Executing the tests:

::

$ flake8
$ pytest

Changelog
=========

0.8.1
----------------------------
- Add tests for docs (`@Flimm`_)
- Make 'cli' support optional. Use ``pip install python-dotnev[cli]``. (`@theskumar`_)

0.8.0
----------------------------
- ``set_key`` and ``unset_key`` only modified the affected file instead of parsing and re-writing file, this causes comments and other file entact as it is.
- Add support for ``export`` prefix in the line.
- Internal refractoring (`@theskumar`_)
- Allow ``load_dotenv`` and ``dotenv_values`` to work with ``StringIO())`` (`@alanjds`_)(`@theskumar`_) (`#78`_)

0.7.1
----------------------------

- Remove hard dependency on iPython (`@theskumar`_)

0.7.0
----------------------------

- Add support to override system environment variable via .env. (`@milonimrod`_) (`#63`_)
- Disable ".env not found" warning by default (`@maxkoryukov`_) (`#57`_)

0.6.5
----------------------------
- Add support for special characters ``\``. (`@pjona`_) (`#60`_)

0.6.4
----------------------------
- Fix issue with single quotes (`@Flimm`_) (`#52`_)

0.6.3
----------------------------
- Handle unicode exception in setup.py (`#46`_)

0.6.2
----------------------------
- Fix `dotenv list` command (`@ticosax`_)
- Add iPython Suport (`@tillahoffmann`_)

0.6.0
----------------------------
- Drop support for Python 2.6
- Handle escaped charaters and newlines in quoted values. (Thanks `@iameugenejo`_)
- Remove any spaces around unquoted key/value. (Thanks `@paulochf`_)
- Added POSIX variable expansion. (Thanks `@hugochinchilla`_)

0.5.1
----------------------------
- Fix `find_dotenv` - it now start search from the file where this function is called from.

0.5.0
----------------------------
- Add ``find_dotenv`` method that will try to find a ``.env`` file. (Thanks `@isms`_)

0.4.0
----------------------------
- cli: Added ``-q/--quote`` option to control the behaviour of quotes around values in ``.env``. (Thanks `@hugochinchilla`_).
- Improved test coverage.

.. _@alanjds: https://github.com/alanjds
.. _@milonimrod: https://github.com/milonimrod
.. _@maxkoryukov: https://github.com/maxkoryukov
.. _@pjona: https://github.com/pjona
.. _@Flimm: https://github.com/Flimm
.. _@ticosax: https://github.com/ticosax
.. _@tillahoffmann: https://github.com/tillahoffmann
.. _@hugochinchilla: https://github.com/hugochinchilla
.. _@isms: https://github.com/isms
.. _@iameugenejo: https://github.com/iameugenejo
.. _@paulochf: https://github.com/paulochf
.. _@theskumar: https://github.com/theskumar

.. _#78: https://github.com/theskumar/python-dotenv/issues/78
.. _#63: https://github.com/theskumar/python-dotenv/issues/63
.. _#60: https://github.com/theskumar/python-dotenv/issues/60
.. _#57: https://github.com/theskumar/python-dotenv/issues/57
.. _#52: https://github.com/theskumar/python-dotenv/issues/52
.. _#46: https://github.com/theskumar/python-dotenv/issues/46

.. Saurabh Kumar: https://saurabh-kumar.com

.. |Build Status| image:: https://travis-ci.org/theskumar/python-dotenv.svg?branch=master
:target: https://travis-ci.org/theskumar/python-dotenv
.. |Coverage Status| image:: https://coveralls.io/repos/theskumar/python-dotenv/badge.svg?branch=master
:target: https://coveralls.io/r/theskumar/python-dotenv?branch=master
.. |PyPI version| image:: https://badge.fury.io/py/python-dotenv.svg
:target: http://badge.fury.io/py/python-dotenv
.. |PyPI| image:: https://img.shields.io/pypi/dm/python-dotenv.svg
:target: http://badge.fury.io/py/python-dotenv