Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document project_urls as an option to setup.py #441

Merged
merged 3 commits into from
Feb 22, 2018
Merged

Document project_urls as an option to setup.py #441

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e253dd
Document `project_urls` as an option to setup.py
therealphildini Feb 22, 2018
a775773
Improve wording
therealphildini Feb 22, 2018
2953afa
Change to `Tracker`, add `Documentation`
therealphildini Feb 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions source/tutorials/distributing-packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,23 @@ keywords
List keywords that describe your project.


project_urls
~~~~~~~~~~~~

::

project_urls={
'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most projects also use their issue tracker for feature requests, so Bug Reports doesn't feel quite right here. The PEP 459 draft suggested using the generic term Tracker, without saying anything specific about what was being tracked (bug tracker, issue tracker, request tracker, ticket tracker, etc).

'Funding': 'https://donate.pypi.org',
'Say Thanks!': 'http://saythanks.io/to/example',
'Source': 'https://github.com/pypa/sampleproject/',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add a self-referential link back to this page in order to show an example documentation link:

'Documentation': 'https://packaging.python.org/tutorials/distributing-packages/'

},

List additional relevant URLs about your project. This is the place to link to
bug trackers, source repositories, or where to support package development.
The string of the key is the exact text that will be displayed on PyPI.


packages
~~~~~~~~

Expand Down