Skip to content

Commit 99d2c72

Browse files
committed
Add documentation clarifying how to reliably install setuptools with its dependencies.
Ref #4483
1 parent 08bd311 commit 99d2c72

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/userguide/quickstart.rst

+11-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Installation
77

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

10-
pip install --upgrade setuptools
10+
pip install --upgrade setuptools[core]
1111

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

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

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

6171
Historically this documentation has unnecessarily listed ``wheel``

0 commit comments

Comments
 (0)