question-mark
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.

PyPi only rendering first line of long_description

See original GitHub issue

Yesterday, I published the initial alpha of my project on PyPi. This release has a correctly-rendered description.

Today, I made some additions to the README and now PyPi is only rendering the first line in the file, regardless of what’s actually there.

I’ve checked my README both with readme_renderer via setup.py check -r -s and also using restview, and everything seems to be just fine. I’m using Python 3.6.1 when checking that way. Additionally, GitHub appears to be perfectly happy with the README.

Is this a bug, or did I miss something obscure?


EDIT: rstcheck finds no errors either.

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:8 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
dicommented, Jan 4, 2018

PyPi doesn’t render the top header, but I’m assuming this is intentional.

Yes, this is intentional.

I can’t help but feel like the line endings shouldn’t cause this problem, though.

Agreed. Looking a little deeper it seems like the blame lies on pkginfo (which twine uses):

>>> import pkginfo
>>> pkginfo.SDist('melcloud-0.0.3.tar.gz').description
"This is a module providing access to Mitsubishi's `MELCloud <https://www.melcloud.com/>`_ API."

Going to close this since you’ve resolved it and it’s definitely not an issue with readme_renderer. Perhaps this should be raised over at the pkginfo issue tracker instead?

0reactions
tseavercommented, Aug 18, 2018

As I noted on the LP bug:

The “body” part of the ‘METADATA’ file is returned by ‘email.parser.Parser.get_payload’. ‘pkginfo’ does no other handling of it.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Markdown long description on wheel rendered as restructured ...
Hi, the project description as seen in https://pypi.org/project/guibot/ does not render as markdown despite me setting the ...
Read more >
How to make PyPi description Markdown work? - Stack Overflow
I've had issues with \r characters causing parsing issues where only the first line of the README appears in pypi. The code below...
Read more >
tsplib95 - PyPI
Render to text, write to file, or save to filepath. Parsing text, reading files, and loading filepaths are all now supported. Deprecated the...
Read more >
restview - PyPI
A viewer for ReStructuredText documents that renders them on the fly. Pass the name of a ReStructuredText document to restview, and it will...
Read more >
handcalcs - PyPI
First, import the module and run the cell: ... First import handcalcs . ... handcalcs renders lines of code vertically, one after the...
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 Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found