Skip to content

Commit cddfd43

Browse files
committed
feat: add project_urls example
In #823, it was mentioned that project_urls might be a good thing to show. This adds that example.
1 parent 1ae4b30 commit cddfd43

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ an escape hatch when absolutely necessary.
134134
long_description = file: README.md
135135
long_description_content_type = text/markdown
136136
url = https://github.com/pypa/sampleproject
137+
project_urls =
138+
Bug Tracker = https://github.com/pypa/sampleproject/issues
137139
classifiers =
138140
Programming Language :: Python :: 3
139141
License :: OSI Approved :: MIT License
@@ -169,6 +171,8 @@ an escape hatch when absolutely necessary.
169171
- ``url`` is the URL for the homepage of the project. For many projects, this
170172
will just be a link to GitHub, GitLab, Bitbucket, or similar code hosting
171173
service.
174+
- ``project_urls`` lets you list any number of extra links to show in PyPI.
175+
Generally this could be to documentation, issue trackers, etc.
172176
- ``classifiers`` gives the index and :ref:`pip` some additional metadata
173177
about your package. In this case, the package is only compatible with Python
174178
3, is licensed under the MIT license, and is OS-independent. You should
@@ -234,6 +238,9 @@ an escape hatch when absolutely necessary.
234238
long_description=long_description,
235239
long_description_content_type="text/markdown",
236240
url="https://github.com/pypa/sampleproject",
241+
project_urls={
242+
"Bug Tracker": https://github.com/pypa/sampleproject/issues",
243+
}
237244
classifiers=[
238245
"Programming Language :: Python :: 3",
239246
"License :: OSI Approved :: MIT License",
@@ -266,6 +273,8 @@ an escape hatch when absolutely necessary.
266273
- ``url`` is the URL for the homepage of the project. For many projects, this
267274
will just be a link to GitHub, GitLab, Bitbucket, or similar code hosting
268275
service.
276+
- ``project_urls`` lets you list any number of extra links to show in PyPI.
277+
Generally this could be to documentation, issue trackers, etc.
269278
- ``classifiers`` gives the index and :ref:`pip` some additional metadata
270279
about your package. In this case, the package is only compatible with Python
271280
3, is licensed under the MIT license, and is OS-independent. You should

0 commit comments

Comments
 (0)