jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

clarified purpose of `pip install -e` command 

ref #1937
This commit is contained in:
Skylar Downes 2016-09-15 14:55:54 -07:00 committed by GitHub
parent b4fd74c6ff
commit 07ad71e851
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/en/goodpractices.rst
View File

@ -64,6 +64,12 @@ Important notes relating to both schemes:
- **make sure that "mypkg" is importable**, for example by typing once:: - **make sure that "mypkg" is importable**, for example by typing once::
pip install -e . # install package using setup.py in editable mode pip install -e . # install package using setup.py in editable mode
# similar to running python setup.py develop
This installs your package with a symlink to your development code
instead of placing the code directly in the install directory.
This way you can edit the code and run tests on your edits without
having to reinstall every time.
- **avoid "__init__.py" files in your test directories**. - **avoid "__init__.py" files in your test directories**.
This way your tests can run easily against an installed version This way your tests can run easily against an installed version