diff options
author | Jeremy Stanley <fungi@yuggoth.org> | 2017-12-05 17:56:10 +0000 |
---|---|---|
committer | Jeremy Stanley <fungi@yuggoth.org> | 2017-12-05 17:56:10 +0000 |
commit | 7af7f8a68ea4b0f7d45a739273684832fa609935 (patch) | |
tree | c1c021993b3a2d3687e649f8dc0fb46785fb6805 | |
parent | df2246449c271c07586bcecc3eaa36e9b0e94e3d (diff) | |
download | python-setuptools-git-7af7f8a68ea4b0f7d45a739273684832fa609935.tar.gz |
Document project_urls setup parameter
Add an entry to the Setuptools usage documentation for the
project_urls dict, and include it in the "advanced" project example.
While at it, adjust the dogfooding use in Setuptools' own setup.py
to use HTTPS for the Documentation URL and drop redundant entries
for Bug Tracker and Source Code.
Also remove a no-op attribute reassignment from egg_info.py.
-rw-r--r-- | docs/setuptools.txt | 10 | ||||
-rwxr-xr-x | setup.py | 4 | ||||
-rwxr-xr-x | setuptools/command/egg_info.py | 1 |
3 files changed, 11 insertions, 4 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt index e3154b46..bea80181 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -145,6 +145,11 @@ dependencies, and perhaps some data files and scripts:: license="PSF", keywords="hello world example examples", url="http://example.com/HelloWorld/", # project home page, if any + project_urls={ + "Bug Tracker": "https://bugs.example.com/HelloWorld/", + "Documentation": "https://docs.example.com/HelloWorld/", + "Source Code": "https://code.example.com/HelloWorld/", + } # could also include long_description, download_url, classifiers, etc. ) @@ -408,6 +413,11 @@ unless you need the associated ``setuptools`` feature. A list of modules to search for additional fixers to be used during the 2to3 conversion. See :doc:`python3` for more details. +``project_urls`` + An arbitrary map of URL names to hyperlinks, allowing more extensible + documentation of where various resources can be found than the simple + ``url`` and ``download_url`` options provide. + Using ``find_packages()`` ------------------------- @@ -99,9 +99,7 @@ setup_params = dict( keywords="CPAN PyPI distutils eggs package management", url="https://github.com/pypa/setuptools", project_urls={ - "Bug Tracker": "https://github.com/pypa/setuptools/issues", - "Documentation": "http://setuptools.readthedocs.io/", - "Source Code": "https://github.com/pypa/setuptools", + "Documentation": "https://setuptools.readthedocs.io/", }, src_root=None, packages=setuptools.find_packages(exclude=['*.tests']), diff --git a/setuptools/command/egg_info.py b/setuptools/command/egg_info.py index c8b2bd17..a1d41b27 100755 --- a/setuptools/command/egg_info.py +++ b/setuptools/command/egg_info.py @@ -597,7 +597,6 @@ def write_pkg_info(cmd, basename, filename): metadata = cmd.distribution.metadata metadata.version, oldver = cmd.egg_version, metadata.version metadata.name, oldname = cmd.egg_name, metadata.name - metadata.project_urls = cmd.distribution.metadata.project_urls metadata.long_description_content_type = getattr( cmd.distribution, 'long_description_content_type' |