Skip to content

Commit

Permalink
Add brief docs on editable installs via pip.
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Oct 20, 2021
1 parent 54855bb commit 4d9935a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions doc-source/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,23 @@ whey
.. click:: whey.__main__:main
:prog: whey
:nested: none

Editable installs
------------------

Whey also supports :pep:`660` editable installs via :github:repo:`pip <pypa/pip>`.
Editable installs allow changes to the project's source code (but not its entry points and other metadata)
to be automatically reflected when the module is next imported.

To install the project in the current directory in editable mode, run the following command:

.. prompt:: bash

python3 -m pip install --editable .

See the pip documentation_ for more details.

If using pip's ``--no-build-isolation`` flag [1]_, whey must be installed with the ``editable`` extra, as additional requirements are required for editable installs.

.. _documentation: https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e
.. [1] https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-no-build-isolation

0 comments on commit 4d9935a

Please sign in to comment.