diff options
author | Nick Coghlan <ncoghlan@gmail.com> | 2014-10-25 14:00:04 (GMT) |
---|---|---|
committer | Nick Coghlan <ncoghlan@gmail.com> | 2014-10-25 14:00:04 (GMT) |
commit | 3894ae20eac7e77969292fc0536633c648b8d043 (patch) | |
tree | 3e28cc00c746de8068c9e84ad3e4cfd923b44c5d /Doc/library/distutils.rst | |
parent | 8b63d3af9f08c984331629c726d05794a1bbfc4a (diff) | |
download | cpython-3894ae20eac7e77969292fc0536633c648b8d043.zip cpython-3894ae20eac7e77969292fc0536633c648b8d043.tar.gz cpython-3894ae20eac7e77969292fc0536633c648b8d043.tar.bz2 |
Issue #22711: improve links in new distribution docs
- key term hyperlinks for distutils, setuptools & wheel
- distutils landing page links directly to setuptools docs
- short summary of setuptools benefits provided with link
Diffstat (limited to 'Doc/library/distutils.rst')
-rw-r--r-- | Doc/library/distutils.rst | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst index 8e3732b..a7ad837 100644 --- a/Doc/library/distutils.rst +++ b/Doc/library/distutils.rst @@ -13,9 +13,25 @@ additional modules into a Python installation. The new modules may be either collections of Python packages which include modules coded in both Python and C. Most Python users will *not* want to use this module directly, but instead -use the cross-version tools maintained by the Python Packaging Authority. -Refer to the `Python Packaging User Guide <http://packaging.python.org>`_ -for more information. +use the cross-version tools maintained by the Python Packaging Authority. In +particular, +`setuptools <https://setuptools.pypa.io/en/latest/setuptools.html>`__ is an +enhanced alternative to :mod:`distutils` that provides: + +* support for declaring project dependencies +* additional mechanisms for configuring which files to include in source + releases (including plugins for integration with version control systems) +* the ability to declare project "entry points", which can be used as the + basis for application plugin systems +* the ability to automatically generate Windows command line executables at + installation time rather than needing to prebuild them +* consistent behaviour across all supported Python versions + +The recommended `pip <https://pip.pypa.io/>`__ installer runs all +``setup.py`` scripts with ``setuptools``, even if the script itself only +imports ``distutils``. Refer to the +`Python Packaging User Guide <http://packaging.python.org>`_ for more +information. For the benefits of packaging tool authors and users seeking a deeper understanding of the details of the current packaging and distribution |