Skip to content

Commit

Permalink
Add documentation clarifying how to reliably install setuptools with …
Browse files Browse the repository at this point in the history
…its dependencies.

Ref #4483
  • Loading branch information
jaraco committed Jul 22, 2024
1 parent 08bd311 commit 99d2c72
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/userguide/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Installation

You can install the latest version of ``setuptools`` using :pypi:`pip`::

pip install --upgrade setuptools
pip install --upgrade setuptools[core]

Most of the times, however, you don't have to...

Expand Down Expand Up @@ -56,6 +56,16 @@ containing a ``build-system`` section similar to the example below:
This section declares what are your build system dependencies, and which
library will be used to actually do the packaging.

.. note::

Package maintainers might be tempted to use ``setuptools[core]`` as the
requirement, given the guidance above. Avoid doing so, as the extra
is currently considered an internal implementation detail and is likely
to go away in the future and the Setuptools team will not support
compatibility for problems arising from packages published with this
extra declared. Vendored packages will satisfy the dependencies in
the most common isolated build scenarios.

.. note::

Historically this documentation has unnecessarily listed ``wheel``
Expand Down

0 comments on commit 99d2c72

Please sign in to comment.