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.

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

Add and document the project_urls field. #63

Merged
merged 3 commits into from
Feb 21, 2018

Conversation

phildini
Copy link

This field corresponds to
https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
and better documentation in the sampleproject will hopefully encourage use.

This PR comes by way of pypa/setuptools#1276.

This field corresponds to
https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
and better documentation in the sampleproject will hopefully encourage use.
@phildini
Copy link
Author

If this seems to be in the right direction, I will file a matching PR in https://github.com/pypa/python-packaging-user-guide to more thoroughly document.

setup.py Outdated
project_urls={ # Optional
'funding': 'https://donate.pypi.org',
'thanks': 'http://saythanks.io/to/example'
},
Copy link
Member

Choose a reason for hiding this comment

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

One thing to note here is that the key is what's used to render the link text on PyPI. I think it would be ideal to make it clear to a user that they can make this whatever they want, by making the examples looks more human-friendly. It'd also be great to include some of the more common project_urls that this is used for, maybe something like:

    project_urls={  # Optional
        'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
        'Source': 'https://github.com/pypa/sampleproject/',
        'Funding': 'https://donate.pypi.org',
        'Say Thanks!': 'http://saythanks.io/to/example'
    },

If I understand correctly, you're hoping for some consistency with the project keys here to find projects that support saying thanks, but since it's really not enforceable, a better approach might be to just look at all the project_urls values and see if any match what you're looking for.

Copy link
Author

Choose a reason for hiding this comment

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

@di I can definitely add more links! I agree that these aren't enforceable, but I'm hoping good docs and usage patterns will encourage some consistency.

@di di merged commit 941f486 into pypa:master Feb 21, 2018
@di
Copy link
Member

di commented Feb 21, 2018

Thanks @phildini!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants