Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

exclude '.tox', '.nox' from being copied during 'pip install .' #6770

Merged
merged 14 commits into from
Aug 5, 2019
Prev Previous commit
Next Next commit
updated docs
  • Loading branch information
omry committed Aug 3, 2019
commit ec47c866c85a6677a1500d376df5897d8524b075
13 changes: 12 additions & 1 deletion docs/html/reference/pip_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -694,10 +694,21 @@ does not satisfy the ``--require-hashes`` demand that every package have a
local hash.


Local project installs
++++++++++++++++++++++
pip supports installing local project in both regular mode and editable mode.
You can install local projects by specifying the project path to pip::

$ pip install path/to/SomeProject

During the installation, pip will copy the entire project directory to a temporary location and install from there.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say regular installation just so people don't get the idea that it may apply to editable installs.

The exception is that pip will exclude .tox and .nox directories present in the top level of the project from being copied.


.. _`editable-installs`:

"Editable" Installs
+++++++++++++++++++
~~~~~~~~~~~~~~~~~~~

"Editable" installs are fundamentally `"setuptools develop mode"
<https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode>`_
Expand Down