summaryrefslogtreecommitdiffstats
path: root/Doc/distributing
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2014-05-25 14:50:11 (GMT)
committerNick Coghlan <ncoghlan@gmail.com>2014-05-25 14:50:11 (GMT)
commite1d54e5f8e63cf8a464a1c4c3d42e4f3a107b83f (patch)
tree4cabc20a0443e8fcb54680bea588bcc5116fdfa9 /Doc/distributing
parent7df417d50a6c849987d745453fcf6d0786d41ca4 (diff)
downloadcpython-e1d54e5f8e63cf8a464a1c4c3d42e4f3a107b83f.zip
cpython-e1d54e5f8e63cf8a464a1c4c3d42e4f3a107b83f.tar.gz
cpython-e1d54e5f8e63cf8a464a1c4c3d42e4f3a107b83f.tar.bz2
Mention setuptools & wheel as key terms for distribution
Diffstat (limited to 'Doc/distributing')
-rw-r--r--Doc/distributing/index.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst
index d671041..2f2e637 100644
--- a/Doc/distributing/index.rst
+++ b/Doc/distributing/index.rst
@@ -48,6 +48,18 @@ Key terms
standard library, but its name lives on in other ways (such as the name
of the mailing list used to coordinate Python packaging standards
development).
+* ``setuptools`` is a (largely) drop-in replacement for ``distutils`` first
+ published in 2004. It's most notable addition over the unmodified
+ ``distutils`` tools was the ability to declare dependencies on other
+ packages. It is currently recommended as a more regularly updated
+ alternative to ``distutils`` that offers consistent support for more
+ recent packaging standards across a wide range of Python versions.
+* ``wheel`` (in this context) is a project that adds the ``bdist_wheel``
+ command to ``distutils``/``setuptools``. This produces a cross platform
+ binary packaging format (called "wheels" or "wheel files" and defined in
+ :pep:`427`) that allows Python libraries, even those including binary
+ extensions, to be installed on a system without needing to be built
+ locally.
Open source licensing and collaboration
@@ -85,12 +97,16 @@ using ``pip``::
pip install setuptools wheel twine
+The Python Packaging User Guide includes more details on the `currently
+recommended tools`_.
+
+.. _currently recommended tools: https://packaging.python.org/en/latest/current.html#packaging-tool-recommendations
Reading the guide
=================
The Python Packaging User Guide covers the various key steps and elements
-involved in creating a project
+involved in creating a project:
* `Project structure`_
* `Building and packaging the project`_