README on pypi.org not readableSee original GitHub issue
https://pypi.org/project/bump2version/ shows content of README, which is broken.
there seem to be two reasons:
- the value for
long_descriptionis provided as bytes and not as a string
- the content if formatted as markdown and not reStructuredText
With refactored https://pypi.org well readable README can serve as great presentation of the package and
bump2version can definitely do better.
If reStructuredText seems too difficult, I volunteer to write it properly. It is not so difficult and such great tool as bump2version deserves good presentation.
- Created 5 years ago
- Comments:14 (2 by maintainers)
Top GitHub Comments
Note: the latest release of
twine has a ‘check’ command, which checks if the README will render correctly on PyPI. See twine docs.
For the next release, I would recommend:
pip install --upgrade pip pip install --upgrade setuptools pip install --upgrade wheel pip install --upgrade twine pip install readme_renderer[md] setup.py build sdist setup.py build bdist_wheel twine check dist/*