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 additional project URLs to PyPI metadata (docs, changelog, repo) #377

Merged
merged 1 commit into from
Apr 9, 2023

Conversation

intgr
Copy link
Contributor

@intgr intgr commented Mar 29, 2023

These links will be visible on the package's PyPI page, example:

image

Additionally, tools like Renovate bot use these links to provide quicker access to the changelog for a dependency update, and can call GitHub API for additional metadata. Specifically it recognizes Changelog and Repository.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
'https://django-celery-results.readthedocs.io/en/latest/'
'changelog.html'
),
'Repository': 'https://github.com/celery/django-celery-results',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't sure whether I should keep these here, or define them in __init__.py instead as other metadata is? E.g.

__documentation_url__ = (
    'https://django-celery-results.readthedocs.io/en/latest/'
)
__changelog_url__ = (
    'https://django-celery-results.readthedocs.io/en/latest/changelog.html'
)

@auvipy auvipy merged commit 28d9101 into celery:main Apr 9, 2023
@intgr intgr deleted the pypi-project-urls branch May 9, 2023 10:36
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.

None yet

2 participants