Project

Profile

Help

Issue #4277

Pulpcore README isn't displaying properly on pypi

Added by daviddavis 10 months ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

If you look at the README on pypi, it doesn't seem to display the badges properly:

https://pypi.org/project/pulpcore/3.0.0b17/

It seems on other pypi pages these work fine though:

https://pypi.org/project/celery/4.2.1/

Associated revisions

Revision 5876f379 View on GitHub
Added by CodeHeeler 10 months ago

Fix pulpcore README on pypi

The badges weren't displaying properly.
Markdown was not being interpreted correctly and now is.

fixes #4277
https://pulp.plan.io/issues/4277

Revision 5876f379 View on GitHub
Added by CodeHeeler 10 months ago

Fix pulpcore README on pypi

The badges weren't displaying properly.
Markdown was not being interpreted correctly and now is.

fixes #4277
https://pulp.plan.io/issues/4277

History

#1 Updated by CodeHeeler 10 months ago

  • Triaged changed from No to Yes

#2 Updated by CodeHeeler 10 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to CodeHeeler

#3 Updated by CodeHeeler 10 months ago

The steps to get markdown working on pypi are here: https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi/

I want feedback on the following two requirements:
1) setuptools>=38.6.0
2) "You must upload the distribution with twine, and only twine>=1.11.0 will correctly send the metadata to PyPI"

Are we ok with these limitations? If not, the example shared in the ticket from celery shows that we can do the badges with HTML without using markdown if that's a route we'd prefer.

#4 Updated by daviddavis 10 months ago

So Travis builds and uploads our package to PyPI for us. I think we just need to set long_description_content_type in our setup.py and maybe it'll work?

#5 Updated by CodeHeeler 10 months ago

I'm certainly fine with trying that first step only if you think Travis handles the new metadata for us.

#6 Updated by bmbouter 10 months ago

I'm fine w/ those requirements. Travis will use those newer versions.

#8 Updated by CodeHeeler 10 months ago

  • Status changed from ASSIGNED to MODIFIED

#9 Updated by daviddavis 8 months ago

  • Tags Pulp 3 added

#10 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#11 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF