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

Update PyPI README instructions #971

Open
bhrutledge opened this issue Aug 28, 2021 · 2 comments
Open

Update PyPI README instructions #971

bhrutledge opened this issue Aug 28, 2021 · 2 comments
Labels
help wanted type: enhancement A self-contained enhancement or new feature

Comments

@bhrutledge
Copy link
Contributor

While reviewing #969, I noticed that making-a-pypi-friendly-readme.rst uses setup.py, while packaging-projects.rst recommends setup.cfg.

I think the README guide should be updated to use setup.cfg. I think it'd also be nice to link to making-a-pypi-friendly-readme from other relevant guides, such as packaging-projects and distributing-packages-using-setuptools.

Somewhat related: #887

@webknjaz webknjaz added type: enhancement A self-contained enhancement or new feature help wanted labels Aug 29, 2021
@pypa pypa deleted a comment from danielgithub23 Jun 29, 2022
@CAM-Gerlach
Copy link
Contributor

Indeed. The "Include your readme in the package's metadata" section can be almost entirely elided and replaced with just a few lines instructing package authors how to set

long_description = file: README.md
long_description_content_type = text/markdown

The repeated reminders to upgrade packaging tools to versions that are long-supported across the ecosystem is likewise no longer needed, especially since PEP 518 takes care of that anyway and packaging tools don't need to be installed in the user's working environment at all.

The "Validating reST Markup" section could be simplified by using pipx to install and run Twine in one go, though that's somewhat more opinionated

@chrysle
Copy link
Contributor

chrysle commented Sep 28, 2023

After setup.cfg guidance has been entirely replaced with pyproject.toml in #1031 in the linked packaging projects guide,
I think the README instructions should adapt to that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted type: enhancement A self-contained enhancement or new feature
Projects
None yet
Development

No branches or pull requests

5 participants
@webknjaz @bhrutledge @CAM-Gerlach @chrysle and others