python-dotenv 0.6.4
pip install python-dotenv==0.6.4
Newer version available (1.2.2)
Released:
Add .env support to your django/flask apps in development and deployments
Navigation
Verified details
These details have been verified by PyPIMaintainers
👁 Avatar for bbc from gravatar.combbc 👁 Avatar for theskumar from gravatar.com
theskumar
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: BSD License (UNKNOWN)
- Author: Saurabh Kumar
- Tags environment variables , deployments , settings , env , dotenv , configurations , python
Classifiers
- Development Status
- Environment
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Project description
::
_______ .__ __. ____ ____
| ____|| \ | | \ \ / /
| |__ | \| | \ \/ /
| __| | . ` | \ /
__ | |____ | |\ | \ /
(__)|_______||__| \__| \__/
python-dotenv | |Build Status| |Coverage Status| |PyPI version| |PyPI|
======================================================================
Reads the key,value pair from ``.env`` and adds them to environment
variable. It is great of 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 <#releated-projects>`__
- `Contributing <#contributing>`__
- `Changelog <#changelog>`__
Usages
======
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 os.path import join, dirname
from dotenv import load_dotenv
dotenv_path = join(dirname(__file__), '.env')
load_dotenv(dotenv_path)
Alternatively, 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())
Now, you can access the variables either from system environment
variable or loaded from ``.env`` file. **System environment variables
gets higher precedence** and it's advised not to include it in version control.
.. code:: python
# settings.py
SECRET_KEY = os.environ.get("SECRET_KEY")
DATABASE_PASSWORD = os.environ.get("DATABASE_PASSWORD")
``.env`` is a simple text file. With each environment variables listed
per line, in the format of ``KEY="Value"``, lines starting with `#` is
ignored.
.. code:: shell
SOME_VAR=someval
# I am a comment and that is OK
FOO="BAR"
``.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}
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
Command-line interface
======================
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.
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
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
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
Releated 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>`__
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 <https://saurabh-kumar.com>`__ 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.6.4
----
- Fix issue with single quotes (`@Flimm`) (`#52 <https://github.com/theskumar/python-dotenv/issues/52>`__)
0.6.3
----
- Handle unicode exception in setup.py (`#46 <https://github.com/theskumar/python-dotenv/issues/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.
.. _@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
.. |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
_______ .__ __. ____ ____
| ____|| \ | | \ \ / /
| |__ | \| | \ \/ /
| __| | . ` | \ /
__ | |____ | |\ | \ /
(__)|_______||__| \__| \__/
python-dotenv | |Build Status| |Coverage Status| |PyPI version| |PyPI|
======================================================================
Reads the key,value pair from ``.env`` and adds them to environment
variable. It is great of 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 <#releated-projects>`__
- `Contributing <#contributing>`__
- `Changelog <#changelog>`__
Usages
======
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 os.path import join, dirname
from dotenv import load_dotenv
dotenv_path = join(dirname(__file__), '.env')
load_dotenv(dotenv_path)
Alternatively, 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())
Now, you can access the variables either from system environment
variable or loaded from ``.env`` file. **System environment variables
gets higher precedence** and it's advised not to include it in version control.
.. code:: python
# settings.py
SECRET_KEY = os.environ.get("SECRET_KEY")
DATABASE_PASSWORD = os.environ.get("DATABASE_PASSWORD")
``.env`` is a simple text file. With each environment variables listed
per line, in the format of ``KEY="Value"``, lines starting with `#` is
ignored.
.. code:: shell
SOME_VAR=someval
# I am a comment and that is OK
FOO="BAR"
``.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}
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
Command-line interface
======================
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.
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
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
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
Releated 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>`__
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 <https://saurabh-kumar.com>`__ 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.6.4
----
- Fix issue with single quotes (`@Flimm`) (`#52 <https://github.com/theskumar/python-dotenv/issues/52>`__)
0.6.3
----
- Handle unicode exception in setup.py (`#46 <https://github.com/theskumar/python-dotenv/issues/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.
.. _@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
.. |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
Project details
Verified details
These details have been verified by PyPIMaintainers
👁 Avatar for bbc from gravatar.combbc 👁 Avatar for theskumar from gravatar.com
theskumar
Unverified details
These details have not been verified by PyPIProject links
Meta
- License: BSD License (UNKNOWN)
- Author: Saurabh Kumar
- Tags environment variables , deployments , settings , env , dotenv , configurations , python
Classifiers
- Development Status
- Environment
- Intended Audience
- License
- Operating System
- Programming Language
- Topic
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file python-dotenv-0.6.4.tar.gz.
File metadata
- Download URL: python-dotenv-0.6.4.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db38f9e42a7bb53c68d0aa3ce97c18b62250dc21b64896be27246dfb96315d55
|
|
| MD5 |
92a14c175553187b8d5e1a54331b0e6c
|
|
| BLAKE2b-256 |
9ec143f80f629f363be1b7b33f66cfc8fe098eb5065c9dcc4e5ce4cabba176ed
|
File details
Details for the file python_dotenv-0.6.4-py2.py3-none-any.whl.
File metadata
- Download URL: python_dotenv-0.6.4-py2.py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bac21323df7ab51765948442392872e0ad89cc5c9122ab7f41bd8ad689fc7c72
|
|
| MD5 |
8e2127dd4c6e5fce3207f76103999511
|
|
| BLAKE2b-256 |
0c9db23992f7d2dc8cde9b8f202f00cfd7f81c2c91ba4c029bd0c6ea409f2b28
|