Project

Profile

Help

Issue #4277

closed

Pulpcore README isn't displaying properly on pypi

Added by daviddavis almost 6 years ago. Updated almost 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:
Quarter:

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/

Actions #1

Updated by CodeHeeler almost 6 years ago

  • Triaged changed from No to Yes
Actions #2

Updated by CodeHeeler almost 6 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to CodeHeeler
Actions #3

Updated by CodeHeeler almost 6 years 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.

Actions #4

Updated by daviddavis almost 6 years 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?

Actions #5

Updated by CodeHeeler almost 6 years ago

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

Actions #6

Updated by bmbouter almost 6 years ago

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

Added by CodeHeeler almost 6 years ago

Revision 5876f379 | View on GitHub

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

Added by CodeHeeler almost 6 years ago

Revision 5876f379 | View on GitHub

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

Actions #8

Updated by CodeHeeler almost 6 years ago

  • Status changed from ASSIGNED to MODIFIED
Actions #9

Updated by daviddavis almost 6 years ago

  • Tags Pulp 3 added
Actions #10

Updated by daviddavis over 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions #11

Updated by bmbouter over 5 years ago

  • Tags deleted (Pulp 3)
Actions #12

Updated by bmbouter almost 5 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF