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

Jump to bottom

Add guidance on core dependencies #4507

Merged
merged 1 commit into from
Jul 28, 2024
Merged

Add guidance on core dependencies #4507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion docs/userguide/quickstart.rst
View file
Open in desktop
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
Loading