Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

README on not readable

See original GitHub issue shows content of README, which is broken.

there seem to be two reasons:

  • the value for long_description is provided as bytes and not as a string
  • the content if formatted as markdown and not reStructuredText

With refactored 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.

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:14 (2 by maintainers)

github_iconTop GitHub Comments

Mattwmaster58commented, Jul 17, 2018

screw it, why not? #24

florislacommented, Oct 31, 2018

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] build sdist build bdist_wheel
twine check dist/*
Read more comments on GitHub >

github_iconTop Results From Across the Web

Markdown README not displaying on PyPI (despite ... - GitHub
When publishing a project with a (Markdown) as the long_description and long_description_content_type='text/markdown' then PyPI ...
Read more >
My rst README is not formatted on
It seems that pypi uses a whitelist to filter link protocols (http vs ftp vs gopher), and sees '#' as an invalid protocol....
Read more >
Making a PyPI-friendly README
This guide helps you create a README in a PyPI-friendly format and include your README in your package so it appears on PyPI....
Read more >
How to Publish an Open-Source Python Package to PyPI
In this step-by-step tutorial, you'll learn how to create a Python package for your project and how to publish it to PyPI, the...
Read more >
PyPI Repositories - JFrog - JFrog Documentation
Access to remote PyPI repositories (such as ) ... not found: should have one of README, README.rst, README.txt,
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found