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

Replaced the explicit readme.text and readme.content-type fields with readme="README.md" in pyproject.toml. #2389

Conversation

Schefflera-Arboricola
Copy link

@Schefflera-Arboricola Schefflera-Arboricola commented Feb 12, 2025

Why made this change?

  • Ensures consistency—changes to README.md automatically reflect on PyPI without needing to update pyproject.toml.
  • Allows more project details to be displayed on PyPI.
  • Reduces maintenance overhead by avoiding redundant updates.
  • Makes the pyproject.toml less populated

Let me know if there's any concern about showing too much on PyPI. Happy to adjust if needed.

Thank you :)

  • I am familiar with the contributing guidelines
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

@cwhanse
Copy link
Member

cwhanse commented Feb 12, 2025

astropy and numpy do this, so I'll thumbs up to imitate them.

@kandersolar we ought to also add the maintainers block I think?

@adriesse
Copy link
Member

I did some looking around when setting this up for my own new repo and concluded that I liked having more timeless, generic and succinct info on PyPI, vs. more recent, specific and detailed info on github. I didn't take notes, but there were others like that.

@kandersolar
Copy link
Member

I am of the same mind as Anton: simple=better on PyPI. And we don't change this text very often, so there's not a major avoided burden by keeping them synced automatically. But I don't feel strongly about it.

@kandersolar we ought to also add the maintainers block I think?

I don't think we need to in any technical sense. We have authors, and the packaging community hasn't converged on a clear distinction between authors vs maintainers: https://packaging.python.org/en/latest/specifications/pyproject-toml/#authors-maintainers

I wouldn't object to a PR that creates a maintainers block that duplicates the current authors block, but I don't see a clear benefit and I don't think it's worth the small cost of the PR.

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.

4 participants