Skip to content

Commit 9f8001d

Browse files
committed
Update for current python versions
1 parent 12341bd commit 9f8001d

File tree

1 file changed

+31
-32
lines changed

1 file changed

+31
-32
lines changed

CONTRIBUTING.md

+31-32
Original file line numberDiff line numberDiff line change
@@ -16,46 +16,44 @@ suite against multiple python versions. I recommend
1616
these various versions. If you are a Windows user, `pyenv` won't work for you,
1717
but [conda](https://conda.io/) can also be used to solve this problem.
1818

19-
This distribution includes a shell script `build-pyenvs.sh` which
20-
automates the creation of these environments.
19+
This distribution includes a shell script `build-pyenvs.sh` which automates
20+
the creation of these environments.
2121

2222
If you prefer to create these virtual envs by hand, do the following:
2323
```
2424
$ cd cmd2_abbrev
25+
$ pyenv install 3.8.0
26+
$ pyenv virtualenv -p python3.8 3.8.0 cmd2-3.8
2527
$ pyenv install 3.7.0
26-
$ pyenv virtualenv -p python3.7 3.7.0 cmd2-3.7
28+
$ pyenv virtualenv -p python3.7 3.7.5 cmd2-3.7
2729
$ pyenv install 3.6.5
28-
$ pyenv virtualenv -p python3.6 3.6.5 cmd2-3.6
30+
$ pyenv virtualenv -p python3.6 3.6.9 cmd2-3.6
2931
$ pyenv install 3.5.5
30-
$ pyenv virtualenv -p python3.5 3.5.5 cmd2-3.5
31-
$ pyenv install 3.4.8
32-
$ pyenv virtualenv -p python3.4 3.4.8 cmd2-3.4
32+
$ pyenv virtualenv -p python3.5 3.5.8 cmd2-3.5
3333
```
3434

3535
Now set pyenv to make all three of those available at the same time:
3636
```
37-
$ pyenv local cmd2-3.7 cmd2-3.6 cmd2-3.5 cmd2-3.4
37+
$ pyenv local cmd2-3.8 cmd2-3.7 cmd2-3.6 cmd2-3.5
3838
```
3939

4040
Whether you ran the script, or did it by hand, you now have isolated
41-
virtualenvs for each of the major python
42-
versions. This table shows various python commands, the version of
43-
python which will be executed, and the virtualenv it will utilize.
41+
virtualenvs for each of the major python versions. This table shows various
42+
python commands, the version of python which will be executed, and the
43+
virtualenv it will utilize.
4444

4545
| Command | python | virtualenv |
4646
| ----------- | ------ | ---------- |
47-
| `python` | 3.7.0 | cmd2-3.6 |
48-
| `python3` | 3.7.0 | cmd2-3.6 |
49-
| `python3.7` | 3.7.0 | cmd2-3.7 |
50-
| `python3.6` | 3.6.5 | cmd2-3.6 |
51-
| `python3.5` | 3.5.5 | cmd2-3.5 |
52-
| `python3.4` | 3.4.8 | cmd2-3.4 |
53-
| `pip` | 3.7.0 | cmd2-3.6 |
54-
| `pip3` | 3.7.0 | cmd2-3.6 |
55-
| `pip3.7` | 3.7.0 | cmd2-3.7 |
56-
| `pip3.6` | 3.6.5 | cmd2-3.6 |
57-
| `pip3.5` | 3.5.5 | cmd2-3.5 |
58-
| `pip3.4` | 3.4.8 | cmd2-3.4 |
47+
| `python` | 3.8.0 | cmd2-3.8 |
48+
| `python3` | 3.8.0 | cmd2-3.8 |
49+
| `python3.7` | 3.7.5 | cmd2-3.7 |
50+
| `python3.6` | 3.6.9 | cmd2-3.6 |
51+
| `python3.5` | 3.5.8 | cmd2-3.5 |
52+
| `pip` | 3.8.0 | cmd2-3.8 |
53+
| `pip3` | 3.8.0 | cmd2-3.8 |
54+
| `pip3.7` | 3.7.5 | cmd2-3.7 |
55+
| `pip3.6` | 3.6.9 | cmd2-3.6 |
56+
| `pip3.5` | 3.5.8 | cmd2-3.5 |
5957

6058

6159
## Install Dependencies
@@ -68,23 +66,24 @@ $ pip install -e .[dev]
6866
This command also installs `cmd2-abbrev` "in-place", so the package points to
6967
the source code instead of copying files to the python `site-packages` folder.
7068

71-
All the dependencies now have been installed in the `cmd2-3.7`
69+
All the dependencies now have been installed in the `cmd2-3.8`
7270
virtualenv. If you want to work in other virtualenvs, you'll need to manually
7371
select it, and install again::
7472

75-
$ pyenv shell cmd2-3.4
73+
$ pyenv shell cmd2-3.6
7674
$ pip install -e .[dev]
7775

7876
## Common Development Tasks
7977

8078
This project uses many other python modules for various development tasks,
8179
including testing, linting, building wheels, and distributing releases. These
8280
modules can be configured many different ways, which can make it difficult to
83-
learn the specific incantations required for each project you are familiar with.
81+
learn the specific incantations required for each project you are familiar
82+
with.
8483

85-
This project uses [invoke](<http://www.pyinvoke.org>) to provide a clean,
86-
high level interface for these development tasks. To see the full list of
87-
functions available:
84+
This project uses [invoke](<http://www.pyinvoke.org>) to provide a clean, high
85+
level interface for these development tasks. To see the full list of functions
86+
available:
8887
```
8988
$ invoke -l
9089
```
@@ -94,9 +93,9 @@ You can run multiple tasks in a single invocation, for example:
9493
$ invoke clean docs sdist wheel
9594
```
9695

97-
That one command will remove all superflous cache, testing, and build
98-
files, render the documentation, and build a source distribution and a
99-
wheel distribution.
96+
That one command will remove all superflous cache, testing, and build files,
97+
render the documentation, and build a source distribution and a wheel
98+
distribution.
10099

101100
For more information, read `tasks.py`.
102101

0 commit comments

Comments
 (0)