Skip to content

Commit 504e3db

Browse files
committed
Added documentation about Python 3.4 and earlier now having an additional dependency on contextlib2
1 parent 6c2cdf2 commit 504e3db

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
* Other changes
3131
* The **edit** command no longer allows you to edit prior commands. The capability to edit prior commands is now part of the **history** command. The **edit** command still allows you to edit arbitrary files.
3232
* the **autorun_on_edit** setting has been removed.
33+
* For Python 3.4 and earlier, ``cmd2`` now has an additional dependency on the ``contextlib2`` module
3334
* Deprecations
3435
* The old **options** decorator for optparse-based argument parsing is now *deprecated*
3536
* The old decorator is still present for now, but will be removed in a future release

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ pip install -U cmd2
4848

4949
cmd2 works with Python 2.7 and Python 3.4+ on Windows, macOS, and Linux. It is pure Python code with
5050
the only 3rd-party dependencies being on [six](https://pypi.python.org/pypi/six),
51-
[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip)
52-
(on Windows, [pyreadline](https://pypi.python.org/pypi/pyreadline) is an additional dependency).
51+
[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip).
52+
Windows has an additional dependency on [pyreadline](https://pypi.python.org/pypi/pyreadline) and Python
53+
3.4 and earlier have an additional dependency on [contextlib2](https://pypi.python.org/pypi/contextlib2).
5354

5455
For information on other installation options, see
5556
[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2

docs/install.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,11 @@ If you wish to permanently uninstall ``cmd2``, this can also easily be done with
128128

129129
pip uninstall cmd2
130130

131+
Extra requirement for Python 3.4 and earlier
132+
--------------------------------------------
133+
``cmd2`` requires the ``contextlib2`` module for Python 3.4 and earlier. This is used to temporarily redirect
134+
stdout and stderr.
135+
131136
Extra requirement for Python 2.7 only
132137
-------------------------------------
133138
If you want to be able to pipe the output of commands to a shell command on Python 2.7, then you will need one

0 commit comments

Comments
 (0)