@@ -660,25 +660,28 @@ For example::
660660Working in "development mode"
661661=============================
662662
663- Although not required, it's common to locally install your project in "editable"
664- or "develop" mode while you're working on it. This allows your project to be
665- both installed and editable in project form.
663+ You can install a project in "editable"
664+ or "develop" mode while you're working on it.
665+ When installed as editable, a project can be
666+ edited in-place without reinstallation:
667+ changes to Python source files in projects installed as editable will be reflected the next time an interpreter process is started.
666668
667- Assuming you're in the root of your project directory, then run:
669+ To install a Python package in "editable"/"development" mode
670+ Change directory to the root of the project directory and run:
668671
669672.. code-block :: bash
670673
671674 python -m pip install -e .
672675
673676
674- Although somewhat cryptic, ``-e `` is short for ``--editable ``, and ``. `` refers
677+ The pip command-line flag ``-e `` is short for ``--editable ``, and ``. `` refers
675678to the current working directory, so together, it means to install the current
676679directory (i.e. your project) in editable mode. This will also install any
677680dependencies declared with ``install_requires `` and any scripts declared with
678681``console_scripts ``. Dependencies will be installed in the usual, non-editable
679682mode.
680683
681- It's fairly common to also want to install some of your dependencies in editable
684+ You may want to install some of your dependencies in editable
682685mode as well. For example, supposing your project requires "foo" and "bar", but
683686you want "bar" installed from VCS in editable mode, then you could construct a
684687requirements file like so::
0 commit comments