You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
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
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.
While reviewing #969, I noticed that making-a-pypi-friendly-readme.rst uses
setup.py
, while packaging-projects.rst recommendssetup.cfg
.I think the README guide should be updated to use
setup.cfg
. I think it'd also be nice to link tomaking-a-pypi-friendly-readme
from other relevant guides, such as packaging-projects and distributing-packages-using-setuptools.Somewhat related: #887
The text was updated successfully, but these errors were encountered: