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

setup.cfg: add metadata.project_urls #71

Merged
merged 3 commits into from
Feb 12, 2023
Merged

Conversation

generalmimon
Copy link
Member

@generalmimon generalmimon commented Sep 16, 2022

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):

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

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 Show resolved Hide resolved
@KOLANICH
Copy link
Contributor

IMHO it'd be a bit redundant to add the links source code and issue tracker since everyone knows that source code hostings (GitHub currently) are used for that. So IMHO 1 homepage link to this repo is enough. The links to the docs ... you don't have to limit oneself. Proposal: 1 link to the docs for python runtime, and another one to the guide to KS language.

@KOLANICH
Copy link
Contributor

Also: setup.cfg is deprecated, convert it to pyproject.toml using ini2toml tool.

Copy link
Contributor

@dgelessus dgelessus left a comment

Choose a reason for hiding this comment

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

The list of links looks good to me. I personally wouldn't have added a Twitter link here (I think it's not all that relevant when coming from PyPI), but I have no problem with keeping it if the list doesn't become too long.

A link to the docs sounds good, but I have no strong opinion about linking to the main docs or the Python notes (the reader can always click through to the other docs if needed).

@dgelessus
Copy link
Contributor

dgelessus commented Sep 16, 2022

Also: setup.cfg is deprecated,

From where do you have that information? The setuptools docs for setup.cfg don't mention anything about it being deprecated. All I can find is pypa/setuptools/milestone/7 about eventually deprecating setup.cfg, but that hasn't happened yet. The setuptools maintainers also mentioned in multiple places that the deprecation period would probably be "forever", so there's no rush.

convert it to pyproject.toml using ini2toml tool.

That's still not an option. As before, pyproject.toml-based configuration requires setuptools 61.0.0, which requires Python 3.7, and we still supports version before that.

In any case, switching to a different configuration format is off-topic for this PR.

@generalmimon
Copy link
Member Author

@dgelessus:

The list of links looks good to me. I personally wouldn't have added a Twitter link here (I think it's not all that relevant when coming from PyPI)

I agree that it's not that relevant for the Python runtime, and it's not clear what a Python user would find there.

@generalmimon
Copy link
Member Author

@dgelessus:

A link to the docs sounds good, but I have no strong opinion about linking to the main docs or the Python notes (the reader can always click through to the other docs if needed).

That's true, so I think the main docs are fine.

@generalmimon generalmimon merged commit 4a6e228 into master Feb 12, 2023
@generalmimon generalmimon deleted the add-project-urls branch February 12, 2023 09:12
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.

PyPI project page does not link to GitHub repo
3 participants