Skip to content

Commit 8954361

Browse files
authored
Update distributing-packages-using-setuptools.rst
1 parent 8c1f843 commit 8954361

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

source/guides/distributing-packages-using-setuptools.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -659,24 +659,27 @@ For example::
659659
Working in "development mode"
660660
=============================
661661

662-
Although not required, it's common to locally install your project in "editable"
663-
or "develop" mode while you're working on it. This allows your project to be
664-
both installed and editable in project form.
662+
You can install a project in "editable"
663+
or "develop" mode while you're working on it.
664+
When installed as editable, a project can be
665+
edited in-place without reinstallation:
666+
changes to Python source files in projects installed as editable will be reflected the next time an interpreter process is started.
665667

666-
Assuming you're in the root of your project directory, then run:
668+
To install a Python package in "editable"/"development" mode
669+
Change directory to the root of the project directory and run ``pip install -e .``:
667670

668671
::
669672

670673
pip install -e .
671674

672675

673-
Although somewhat cryptic, ``-e`` is short for ``--editable``, and ``.`` refers
676+
The pip command-line flag ``-e`` is short for ``--editable``, and ``.`` refers
674677
to the current working directory, so together, it means to install the current
675678
directory (i.e. your project) in editable mode. This will also install any
676679
dependencies declared with "install_requires" and any scripts declared with
677680
"console_scripts". Dependencies will be installed in the usual, non-editable mode.
678681

679-
It's fairly common to also want to install some of your dependencies in editable
682+
You may want to install some of your dependencies in editable
680683
mode as well. For example, supposing your project requires "foo" and "bar", but
681684
you want "bar" installed from VCS in editable mode, then you could construct a
682685
requirements file like so::

0 commit comments

Comments
 (0)