Document project_urls as an option to setup.py
#441
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`project_urls` is an allowed option to `setup()` that provides a really nice place for maintainers to add bug tracker or funding URLs. The hope is that by documenting the usage, maintainers will be encouraged to add more useful URLs to their setup.py
ncoghlan
approved these changes
Feb 22, 2018
| :: | ||
|
|
||
| project_urls={ | ||
| 'Bug Reports': 'https://github.com/pypa/sampleproject/issues', |
There was a problem hiding this comment.
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).
| 'Bug Reports': 'https://github.com/pypa/sampleproject/issues', | ||
| 'Funding': 'https://donate.pypi.org', | ||
| 'Say Thanks!': 'http://saythanks.io/to/example', | ||
| 'Source': 'https://github.com/pypa/sampleproject/', |
There was a problem hiding this comment.
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/'
|
Thanks for this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
project_urlsis an allowed option tosetup()that provides a really niceplace for maintainers to add bug tracker or funding URLs. The hope is that by
documenting the usage, maintainers will be encouraged to add more useful URLs
to their setup.py.
This ticket comes by way of pypa/setuptools#1276 and the corresponding PR in
sampleprojecthas already been merged: pypa/sampleproject#63