Merge pull request #241 from python-cmd2/windows_pyreadline

Added a Windows-only dependency on pyreadline

6 files changed, 41 insertions, 3 deletions

diff --git a/.appveyor.yml b/.appveyor.yml
index c397472f..fad8437a 100644
--- a/.appveyor.yml
+++ b/.appveyor.yml
@@ -4,4 +4,4 @@ install:
 build: off
 
 test_script:
-  - python -m tox -e py27,py35,py36-win
+  - python -m tox -e py27-win,py35-win,py36-win
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e2724bce..7c40babb 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,7 +4,8 @@
     * Fixed a couple broken examples
 * Enhancements
     * Improved documentation for modifying shortcuts (command aliases)
-    
+    * Made ``pyreadline`` a dependency on Windows to ensure tab-completion works
+
 ## 0.7.8 (November 8, 2017)
 
 * Bug Fixes
diff --git a/README.md b/README.md
index f1fce0a4..c3625a80 100755
--- a/README.md
+++ b/README.md
@@ -48,7 +48,8 @@ pip install -U cmd2
 
 cmd2 works with Python 2.7 and Python 3.3+ on Windows, macOS, and Linux. It is pure Python code with
 the only 3rd-party dependencies being on [six](https://pypi.python.org/pypi/six),
-[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip).
+[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip) 
+(on Windows, [pyreadline](https://pypi.python.org/pypi/pyreadline) is an additional dependency).
 
 For information on other installation options, see
 [Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2
diff --git a/docs/install.rst b/docs/install.rst
index 1edba409..9e330c3c 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -107,6 +107,10 @@ the following Python packages are installed:
   * pyparsing
   * pyperclip
 
+On Windows, there is an additional dependency:
+
+  * pyreadline
+
 
 Upgrading cmd2
 --------------
diff --git a/setup.py b/setup.py
index c33e19ff..efe715be 100755
--- a/setup.py
+++ b/setup.py
@@ -3,6 +3,7 @@
 """
 Setuptools setup file, used to install or test 'cmd2'
 """
+import sys
 from setuptools import setup
 
 VERSION = '0.7.9a'
@@ -61,6 +62,9 @@ Topic :: Software Development :: Libraries :: Python Modules
 """.splitlines())))
 
 INSTALL_REQUIRES = ['pyparsing >= 2.0.1', 'pyperclip', 'six']
+if sys.platform.startswith('win'):
+    INSTALL_REQUIRES += ['pyreadline']
+
 # unittest.mock was added in Python 3.3.  mock is a backport of unittest.mock to all versions of Python
 TESTS_REQUIRE = ['mock', 'pytest']
 DOCS_REQUIRE = ['sphinx', 'sphinx_rtd_theme', 'pyparsing', 'pyperclip', 'six']
diff --git a/tox.ini b/tox.ini
index b3ecd19f..cefc7f7b 100644
--- a/tox.ini
+++ b/tox.ini
@@ -24,6 +24,22 @@ commands =
   py.test {posargs: -n 2} --cov=cmd2 --cov-report=term-missing
   codecov
 
+[testenv:py27-win]
+deps =
+  codecov
+  mock
+  pyparsing
+  pyperclip
+  pyreadline
+  pytest
+  pytest-cov
+  pytest-xdist
+  six
+  subprocess32
+commands =
+  py.test {posargs: -n 2} --cov=cmd2 --cov-report=term-missing
+  codecov
+
 [testenv:py33]
 deps =
   mock
@@ -54,6 +70,17 @@ deps =
   six
 commands = py.test -v -n2
 
+[testenv:py35-win]
+deps =
+  mock
+  pyparsing
+  pyperclip
+  pyreadline
+  pytest
+  pytest-xdist
+  six
+commands = py.test -v -n2
+
 [testenv:py36]
 deps =
   codecov
@@ -73,6 +100,7 @@ deps =
   mock
   pyparsing
   pyperclip
+  pyreadline
   pytest
   pytest-xdist
   six