Thursday, December 5, 2019

How to check README.rst file before uploading to PyPI

During the first launch of a package, I went through a series of releases because of rendering issues of README.rst on pypi. I pulled up my new package on pypi and was met with unseemly, unformatted text instead of a spiffy display. To avoid that, you can use
1
twine check dist/*
It tested the READEM.rst locally, and it would “warn” you errors.
See: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

No comments:

Post a Comment