Optional cli (theskumar#99)

theskumar · web-flow · commit b8fa11110314 · 2018-03-04T22:05:56.000+05:30
* Add cli as extra option in pip

* move get_cli_string out of cli.py

* Make test happy :)
diff --git a/README.rst b/README.rst
@@ -171,10 +171,16 @@ You can use dotenv with iPython. You can either let the dotenv search for .env w
     %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
diff --git a/dotenv/__init__.py b/dotenv/__init__.py
@@ -1,7 +1,35 @@
-from .cli import get_cli_string
 from .main import load_dotenv, get_key, set_key, unset_key, find_dotenv, dotenv_values
 
 
+def load_ipython_extension(ipython):
+    from .ipython import load_ipython_extension
+    load_ipython_extension(ipython)
+
+
+def get_cli_string(path=None, action=None, key=None, value=None, quote=None):
+    """Returns a string suitable for running as a shell script.
+
+    Useful for converting a arguments passed to a fabric task
+    to be passed to a `local` or `run` command.
+    """
+    command = ['dotenv']
+    if quote:
+        command.append('-q %s' % quote)
+    if path:
+        command.append('-f %s' % path)
+    if action:
+        command.append(action)
+        if key:
+            command.append(key)
+            if value:
+                if ' ' in value:
+                    command.append('"%s"' % value)
+                else:
+                    command.append(value)
+
+    return ' '.join(command).strip()
+
+
 __all__ = ['get_cli_string',
            'load_dotenv',
            'dotenv_values',
@@ -10,8 +38,3 @@
            'unset_key',
            'find_dotenv',
            'load_ipython_extension']
-
-
-def load_ipython_extension(ipython):
-    from .ipython import load_ipython_extension
-    load_ipython_extension(ipython)
diff --git a/dotenv/cli.py b/dotenv/cli.py
@@ -1,6 +1,12 @@
 import os
+import sys
 
-import click
+try:
+    import click
+except ImportError:
+    sys.stderr.write('It seems python-dotenv is not installed with cli option. \n'
+                     'Run pip install "python-dotenv[cli]" to fix this.')
+    sys.exit(1)
 
 from .main import dotenv_values, get_key, set_key, unset_key
 
@@ -72,29 +78,5 @@ def unset(ctx, key):
         exit(1)
 
 
-def get_cli_string(path=None, action=None, key=None, value=None, quote=None):
-    """Returns a string suitable for running as a shell script.
-
-    Useful for converting a arguments passed to a fabric task
-    to be passed to a `local` or `run` command.
-    """
-    command = ['dotenv']
-    if quote:
-        command.append('-q %s' % quote)
-    if path:
-        command.append('-f %s' % path)
-    if action:
-        command.append(action)
-        if key:
-            command.append(key)
-            if value:
-                if ' ' in value:
-                    command.append('"%s"' % value)
-                else:
-                    command.append(value)
-
-    return ' '.join(command).strip()
-
-
 if __name__ == "__main__":
     cli()
diff --git a/setup.py b/setup.py
@@ -19,12 +19,12 @@
     keywords=['environment variables', 'deployments', 'settings', 'env', 'dotenv',
               'configurations', 'python'],
     packages=['dotenv'],
-    install_requires=[
-        'click>=5.0',
-    ],
+    extras_require={
+        'cli': ['click>=5.0', ],
+    },
     entry_points='''
         [console_scripts]
-        dotenv=dotenv:cli.cli
+        dotenv=dotenv.cli:cli
     ''',
     classifiers=[
         # As from https://pypi.python.org/pypi?%3Aaction=list_classifiers
@@ -49,6 +49,7 @@
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: Implementation :: PyPy',
         'Intended Audience :: Developers',
         'Intended Audience :: System Administrators',
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -3,6 +3,7 @@
 from os.path import dirname, join
 
 import dotenv
+from dotenv.cli import cli as dotenv_cli
 
 import sh
 
@@ -23,13 +24,13 @@ def test_get_key():
 
 def test_list(cli, dotenv_file):
     success, key_to_set, value_to_set = dotenv.set_key(dotenv_file, 'HELLO', 'WORLD')
-    result = cli.invoke(dotenv.cli.cli, ['--file', dotenv_file, 'list'])
+    result = cli.invoke(dotenv_cli, ['--file', dotenv_file, 'list'])
     assert result.exit_code == 0, result.output
-    assert result.output == 'HELLO="WORLD"\n'
+    assert result.output == 'HELLO=WORLD\n'
 
 
 def test_list_wo_file(cli):
-    result = cli.invoke(dotenv.cli.cli, ['--file', 'doesnotexists', 'list'])
+    result = cli.invoke(dotenv_cli, ['--file', 'doesnotexists', 'list'])
     assert result.exit_code == 2, result.output
     assert 'Invalid value for "-f"' in result.output
 
@@ -117,7 +118,7 @@ def test_default_path(cli):
         sh.cd(here)
         sh.dotenv('set', 'HELLO', 'WORLD')
         output = sh.dotenv('get', 'HELLO')
-        assert output == 'HELLO="WORLD"\n'
+        assert output == 'HELLO=WORLD\n'
         sh.rm(dotenv_path)
 
 
