README on pypi.org not readable

[vlcinsky]

https://pypi.org/project/bump2version/ 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 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.

[anthrotype]

You can also use github flavoured markdown now, if you set the new long_description_type field.

[c4urself]

@vlcinsky -- thanks for noticing! I really much prefer Markdown and actually rewrote the Readme to markdown recently -- much easier to maintain for me. Let's try @anthrotype's suggestion.

[vlcinsky]

Good @c4urself . You are commander of this ship. As I have never used long_description_type, I leave that modification to other experts.

[anthrotype]

https://github.com/pypa/sampleproject/blob/6a2444b88f48eaa1cf3a2f32fe8bbed8dad82801/setup.py#L70

[ekohl]

https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi is the complete story. You also need somewhat new tools to upload the release to send the correct metadata.

[micahjsmith]

The correct option is long_description_content_type="text/markdown"

[Mattwmaster58]

sooo what are we waiting for here? A PR? As far as I can tell we need to:

• set long_description_content_type="text/markdown" in setup.py
• change

long_description = re.sub(
  "\`(.*)\<#.*\>\`\_",
  r"\1",
  str(open('README.md', 'rb').read()).replace(description, '')
)

to

with open('README.md') as readme:
    long_description = readme.read()

[Mattwmaster58]

screw it, why not? #24

[vlcinsky]

@Mattwmaster58 When opening the file, better use explicit encoding (like "utf-8").

[florisla]

@c4urself Did you upgrade your twine before uploading 0.5.10 to PyPI?

The layout there still seems to be rendered as plain text, not as proper Markdown.
This even though dist-info/METADATA in the Wheel file contains the correct Description-Content-Type.

Also, it seems there's no source distribution (.tar.gz) uploaded at https://pypi.org/simple/bump2version/ .

[c4urself]

@florisla -- I did! I installed twine==1.11.0 and ran the twine upload command, see: https://github.com/c4urself/bump2version/blob/master/Makefile#L12 -- as far as the tar.gz -- I indeed only uploaded the wheel as I thought that's the "future" now?

[ekohl]

@c4urself it is good practice to upload both IMHO

[ekohl]

@c4urself you also had setuptools>=38.6.0 and wheel>=0.31.0 installed?

[florisla]

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/*