Skip to content

Commit e1d54e5

Browse files
committed
Mention setuptools & wheel as key terms for distribution
1 parent 7df417d commit e1d54e5

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

Doc/distributing/index.rst

+17-1
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,18 @@ Key terms
4848
standard library, but its name lives on in other ways (such as the name
4949
of the mailing list used to coordinate Python packaging standards
5050
development).
51+
* ``setuptools`` is a (largely) drop-in replacement for ``distutils`` first
52+
published in 2004. It's most notable addition over the unmodified
53+
``distutils`` tools was the ability to declare dependencies on other
54+
packages. It is currently recommended as a more regularly updated
55+
alternative to ``distutils`` that offers consistent support for more
56+
recent packaging standards across a wide range of Python versions.
57+
* ``wheel`` (in this context) is a project that adds the ``bdist_wheel``
58+
command to ``distutils``/``setuptools``. This produces a cross platform
59+
binary packaging format (called "wheels" or "wheel files" and defined in
60+
:pep:`427`) that allows Python libraries, even those including binary
61+
extensions, to be installed on a system without needing to be built
62+
locally.
5163

5264

5365
Open source licensing and collaboration
@@ -85,12 +97,16 @@ using ``pip``::
8597

8698
pip install setuptools wheel twine
8799

100+
The Python Packaging User Guide includes more details on the `currently
101+
recommended tools`_.
102+
103+
.. _currently recommended tools: https://packaging.python.org/en/latest/current.html#packaging-tool-recommendations
88104

89105
Reading the guide
90106
=================
91107

92108
The Python Packaging User Guide covers the various key steps and elements
93-
involved in creating a project
109+
involved in creating a project:
94110

95111
* `Project structure`_
96112
* `Building and packaging the project`_

0 commit comments

Comments
 (0)