Skip to content

Commit

Permalink
Removed 'wheel install' from docs (#377)
Browse files Browse the repository at this point in the history
  • Loading branch information
di authored Sep 24, 2020
1 parent 9cdf053 commit 2e90eef
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,22 +79,8 @@ This can be changed with the ``--dest-dir`` option::
Installing Wheels
-----------------

.. note:: The ``wheel install`` command is merely a Proof-Of-Concept
implementation and lacks many features provided by pip_. It is meant only
as an example for implementors of packaging tools. End users should use
``pip install`` instead.
To install a wheel file, use pip_::

To install a wheel file in ``site-packages``::

$ wheel install someproject-1.5.0-py2-py3-none.whl

This will unpack the archive in your current site packages directory and
install any console scripts contained in the wheel.

You can accomplish the same in two separate steps (with ``<site-packages-dir>``
being the path to your ``site-packages`` directory::

$ wheel unpack -d <site-packages-dir> someproject-X.Y.Z-py2-py3-none.whl
$ wheel install-scripts someproject
$ pip install someproject-1.5.0-py2-py3-none.whl

.. _pip: https://pypi.org/project/pip/

0 comments on commit 2e90eef

Please sign in to comment.