Skip to content

Commit 34cab6f

Browse files
committed
Document developer setup in README.md
1 parent da1441f commit 34cab6f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,24 +134,25 @@ Start by forking the repository and then modify the code in your fork.
134134
Clone the repository and go inside the code directory. Then you can get the
135135
version with `./setup.py --version`.
136136

137-
We recommend that you use `virtualenv` for development:
137+
We recommend that you use Python3's `venv` for development:
138138

139139
```
140-
$ virtualenv .venv
140+
$ python3 -m venv .venv
141141
$ . .venv/bin/activate
142-
# TODO add requirements.txt: pip install -r requirements.txt
143142
$ pip install .
144143
```
145144

146145
For development purpose, pip can reference the code you are modifying in a
147-
*virtualenv*:
146+
*virtual env*:
148147

149148
```
150-
$ pip install -e .[tests]
149+
$ pip install -e .
150+
# To additionally install all dependencies for development run below command
151+
$ pip install -e '.[tests]'
151152
```
152153

153154
That way, you do not need to run `pip install` again to make your changes
154-
applied to the *virtualenv*.
155+
applied to the *virtual env*.
155156

156157
When the code is ready, submit a Pull Request.
157158

@@ -172,7 +173,7 @@ $ pytest tests/unit
172173

173174
Then you can pass options like `--pdb` or anything supported by `pytest --help`.
174175

175-
To run the tests with different versions of Python in managed *virtualenvs*,
176+
To run the tests with different versions of Python in managed *virtual envs*,
176177
use `tox` (see the configuration in `tox.ini`):
177178

178179
```

0 commit comments

Comments
 (0)