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.

Sign up for GitHub

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

Document how to install provides_extras from local wheel file #9698

Merged
merged 4 commits into from
Jul 25, 2021
Merged

Document how to install provides_extras from local wheel file #9698

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20473d9
Document how to install provides_extras from local wheel file
johnthagen Mar 8, 2021
9e79a3b
Remove warning admonition and use relative file path
johnthagen Mar 8, 2021
910f367
Merge branch 'master' into patch-1
johnthagen Jul 8, 2021
15cb9ec
Add note recommending the use of PEP 508 where possible
johnthagen Jul 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion docs/html/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Specifiers`

py -m pip install SomePackage # latest version
py -m pip install SomePackage==1.0.4 # specific version
py -m pip install 'SomePackage>=1.0.4' # minimum version
py -m pip install 'SomePackage>=1.0.4' # minimum version

For more information and examples, see the :ref:`pip install` reference.

Expand Down Expand Up @@ -271,6 +271,26 @@ To install directly from a wheel archive:

py -m pip install SomePackage-1.0-py2.py3-none-any.whl

To include optional dependencies provided in the ``provides_extras``
metadata in the wheel, you must add quotes around the install target
name:

.. tab:: Unix/macOS

.. code-block:: shell

python -m pip install './somepackage-1.0-py2.py3-none-any.whl[my-extras]'

.. tab:: Windows

.. code-block:: shell

py -m pip install './somepackage-1.0-py2.py3-none-any.whl[my-extras]'

.. note::

In the future, the ``path[extras]`` syntax may become deprecated. It is
recommended to use PEP 508 syntax wherever possible.

For the cases where wheels are not available, pip offers :ref:`pip wheel` as a
convenience, to build wheels for all your requirements and dependencies.
Expand Down