Add ipython magic.

tillahoffmann · Saurabh Kumar · commit c8c29e44e069 · 2016-11-10T08:17:16.000+05:30
- Use cwd. - Remove whitespace. - Remove unused import. - Add load to __all__. - Add docs Thanks @tillahoffmann closes theskumar#34
diff --git a/README.rst b/README.rst
@@ -8,7 +8,7 @@
    (__)|_______||__| \__|     \__/
 
 
-python-dotenv | |Build Status| |Coverage Status| |PyPI version| |PyPI| 
+python-dotenv | |Build Status| |Coverage Status| |PyPI version| |PyPI|
 =================================
 
 Reads the key,value pair from ``.env`` and adds them to environment
@@ -20,8 +20,8 @@ production using `12-factor <http://12factor.net/>`__ principles.
 -  `Usages <#usages>`__
 -  `Installation <#installation>`__
 -  `Command-line interface <#command-line-interface>`__
+-  `iPython Support <#ipython-support>`__
 -  `Setting config on remote
-   servers <#setting-config-on-remote-servers>`__
 -  `Releated Projects <#releated-projects>`__
 -  `Contributing <#contributing>`__
 -  `Changelog <#changelog>`__
@@ -135,6 +135,21 @@ update your settings on remote server, handy isn't it!
       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 usuages.
+
+```
+%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
 --------------------------------
 
@@ -231,7 +246,7 @@ Changelog
 
 dev
 ----------
-- ...
+- Add iPython Suport (@tillahoffmann)
 
 0.6.0
 ----------
@@ -253,6 +268,7 @@ dev
 - cli: Added ``-q/--quote`` option to control the behaviour of quotes around values in ``.env``. (Thanks `@hugochinchilla`_).
 - Improved test coverage.
 
+.. _@tillahoffmann: https://github.com/tillahoffmann
 .. _@hugochinchilla: https://github.com/hugochinchilla
 .. _@isms: https://github.com/isms
 .. _@iameugenejo: https://github.com/iameugenejo
diff --git a/dotenv/__init__.py b/dotenv/__init__.py
@@ -1,4 +1,5 @@
 from .cli import get_cli_string
 from .main import load_dotenv, get_key, set_key, unset_key, find_dotenv
+from .ipython import load_ipython_extension
 
-__all__ = ['get_cli_string', 'load_dotenv', 'get_key', 'set_key', 'unset_key', 'find_dotenv']
+__all__ = ['get_cli_string', 'load_dotenv', 'get_key', 'set_key', 'unset_key', 'find_dotenv', 'load_ipython_extension']
diff --git a/dotenv/ipython.py b/dotenv/ipython.py
@@ -0,0 +1,25 @@
+from __future__ import print_function
+from .main import load_dotenv, find_dotenv
+
+
+def _magic(dotenv_path):
+    """
+    dotenv [dotenv_path]
+
+    Search in increasingly higher folders for the `dotenv_path`
+    """
+    # Locate the .env file
+    dotenv_path = dotenv_path or '.env'
+    try:
+        dotenv_path = find_dotenv(dotenv_path, True, True)
+    except IOError:
+        print("cannot find .env file")
+        return
+
+    # Load the .env file
+    load_dotenv(dotenv_path)
+
+
+def load_ipython_extension(ipython):
+    """Register the %dotenv magic."""
+    ipython.register_magic_function(_magic, magic_name='dotenv')
