Skip to content

Commit fbf2a22

Browse files
committed
Documentation updates
1 parent 5b96488 commit fbf2a22

File tree

5 files changed

+7
-10
lines changed

5 files changed

+7
-10
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,6 @@ dmypy.sock
2828

2929
# cmd2 history file used in main.py
3030
cmd2_history.txt
31+
32+
# Virtual environment
33+
venv

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The tables below list all prerequisites along with the minimum required version
5050
| [attrs](https://github.com/python-attrs/attrs) | `16.3` |
5151
| [colorama](https://github.com/tartley/colorama) | `0.3.7` |
5252
| [pyperclip](https://github.com/asweigart/pyperclip) | `1.5.27` |
53+
| [wcwidth](https://pypi.python.org/pypi/wcwidth) | `0.1.7` |
5354

5455

5556
#### Additional prerequisites to run cmd2 unit tests

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,7 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
5858
pip install -U cmd2
5959
```
6060

61-
cmd2 works with Python 3.4+ on Windows, macOS, and Linux. It is pure Python code with
62-
the only 3rd-party dependencies being on [attrs](https://github.com/python-attrs/attrs),
63-
[colorama](https://github.com/tartley/colorama), [pyperclip](https://github.com/asweigart/pyperclip), and
64-
[wcwidth](https://pypi.python.org/pypi/wcwidth). Windows has an additional dependency on
65-
[pyreadline](https://pypi.python.org/pypi/pyreadline). Finally, Python 3.4 has additional dependencies
66-
on [contextlib2](https://pypi.python.org/pypi/contextlib2) and the [typing](https://pypi.org/project/typing/) backport.
61+
cmd2 works with Python 3.4+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party dependencies.
6762

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

docs/install.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,12 @@ the following Python packages are installed:
101101
* attrs
102102
* colorama
103103
* pyperclip
104+
* wcwidth
104105

105106
On Windows, there is an additional dependency:
106107

107108
* pyreadline
108109

109-
On macOS or Linux, there is an additional dependency:
110-
* wcwidth
111-
112110

113111
Upgrading cmd2
114112
--------------

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666

6767
SETUP_REQUIRES = ['setuptools_scm']
6868

69-
INSTALL_REQUIRES = ['pyperclip >= 1.5.27', 'colorama', 'attrs >= 16.3.0', 'wcwidth']
69+
INSTALL_REQUIRES = ['pyperclip >= 1.5.27', 'colorama', 'attrs >= 16.3.0', 'wcwidth >= 0.1.7']
7070

7171
EXTRAS_REQUIRE = {
7272
# Windows also requires pyreadline to ensure tab completion works

0 commit comments

Comments
 (0)