From 07ad71e851fab1cf4640b9e44c62ddec66319ad2 Mon Sep 17 00:00:00 2001 From: Skylar Downes Date: Thu, 15 Sep 2016 14:55:54 -0700 Subject: [PATCH] clarified purpose of `pip install -e` command ref #1937 --- doc/en/goodpractices.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/en/goodpractices.rst b/doc/en/goodpractices.rst index 7c2fdccf2..3950171aa 100644 --- a/doc/en/goodpractices.rst +++ b/doc/en/goodpractices.rst @@ -64,6 +64,12 @@ Important notes relating to both schemes: - **make sure that "mypkg" is importable**, for example by typing once:: 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**. This way your tests can run easily against an installed version