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

PyPI project page does not link to GitHub repo #69

Closed
generalmimon opened this issue Jul 9, 2022 · 1 comment · Fixed by #71
Closed

PyPI project page does not link to GitHub repo #69

generalmimon opened this issue Jul 9, 2022 · 1 comment · Fixed by #71
Labels
enhancement

Comments

@generalmimon
Copy link
Member

I've just noticed that https://pypi.org/project/kaitaistruct/ doesn't contain any backlink to the source repository, i.e. https://github.com/kaitai-io/kaitai_struct_python_runtime. The "Homepage" in Project links leads to https://kaitai.io:

image

..., which I guess is fine because it's indeed the homepage of the project, but the repo with source code of the package at PyPI is not directly reachable.

I wonder how it can be expressed in setup.cfg - it looks like project_urls is intended for that purpose?

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.

project_urls needs setuptools >= 38.3.0, which is fine, because we already require an even later version (because of the long_description_content_type we're using):

kaitai_struct_python_runtime/setup.cfg

Lines 37 to 38 in c296099

setup_requires =
setuptools >= 38.6.0

@dgelessus
Copy link
Contributor

Yes, project_urls is the correct thing to use here. See for example:

https://github.com/beeware/rubicon-objc/blob/d4533001eee0c7349ebf0007993e9489ba948fc6/setup.cfg#L5-L9

generalmimon added a commit that referenced this issue Sep 16, 2022
@generalmimon
setup.cfg: add metadata.project_urls
edfdae9 
Fix #69

According to a project example https://pypi.org/project/PyScaffold/4.3/
+ https://github.com/pyscaffold/pyscaffold/blob/v4.3/setup.cfg#L7-L15,
the "Homepage" link pulled from `metadata.url` apparently stays even if
I add `project_urls`, so all links at PyPI resulting from this change
should be (I'm not sure about their order, but again links on
https://pypi.org/project/PyScaffold/4.3/ seem to be sorted
alphabetically except the implicit "Homepage" link at the beginning):

- [Homepage](https://kaitai.io)
- [Gitter](https://gitter.im/kaitai_struct/Lobby)
- [Source](https://github.com/kaitai-io/kaitai_struct_python_runtime)
- [Tracker](https://github.com/kaitai-io/kaitai_struct_python_runtime/issues)
- [Twitter](https://twitter.com/kaitai_io)

Currently (see https://pypi.org/project/kaitaistruct/0.10/) the project
links are just:

- [Homepage](https://kaitai.io)
generalmimon added a commit that referenced this issue Sep 16, 2022
@generalmimon
setup.cfg: add metadata.project_urls
4dc0e84 
Fix #69

According to a project example https://pypi.org/project/PyScaffold/4.3/ +
https://github.com/pyscaffold/pyscaffold/blob/v4.3/setup.cfg#L7-L15,
the "Homepage" link pulled from `metadata.url` apparently stays even if
I add `project_urls`, so all links at PyPI resulting from this change
should be (I'm not sure about their order, but again links on
https://pypi.org/project/PyScaffold/4.3/ seem to be sorted
alphabetically except the implicit "Homepage" link at the beginning):

- [Homepage](https://kaitai.io)
- [Gitter](https://gitter.im/kaitai_struct/Lobby)
- [Source](https://github.com/kaitai-io/kaitai_struct_python_runtime)
- [Tracker](https://github.com/kaitai-io/kaitai_struct_python_runtime/issues)
- [Twitter](https://twitter.com/kaitai_io)

Currently (see https://pypi.org/project/kaitaistruct/0.10/) the project
links are just:

- [Homepage](https://kaitai.io)
@generalmimon generalmimon mentioned this issue Sep 16, 2022
Merged
generalmimon added a commit that referenced this issue Feb 12, 2023
@generalmimon
setup.cfg: add metadata.project_urls (#71)
4a6e228 
* setup.cfg: add `metadata.project_urls`

Fix #69

According to a project example https://pypi.org/project/PyScaffold/4.3/ +
https://github.com/pyscaffold/pyscaffold/blob/v4.3/setup.cfg#L7-L15,
the "Homepage" link pulled from `metadata.url` apparently stays even if
I add `project_urls`, so all links at PyPI resulting from this change
should be (I'm not sure about their order, but again links on
https://pypi.org/project/PyScaffold/4.3/ seem to be sorted
alphabetically except the implicit "Homepage" link at the beginning):

- [Homepage](https://kaitai.io)
- [Gitter](https://gitter.im/kaitai_struct/Lobby)
- [Source](https://github.com/kaitai-io/kaitai_struct_python_runtime)
- [Tracker](https://github.com/kaitai-io/kaitai_struct_python_runtime/issues)
- [Twitter](https://twitter.com/kaitai_io)

Currently (see https://pypi.org/project/kaitaistruct/0.10/) the project
links are just:

- [Homepage](https://kaitai.io)

* setup.cfg: remove Twitter link

See #71 (review)

* setup.cfg: add Documentation link to doc.kaitai.io
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

setup.cfg: add metadata.project_urls kaitai-io/kaitai_struct_python_runtime
2 participants
@dgelessus @generalmimon