Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix PyPI long description #1855

Merged
merged 2 commits into from
Apr 16, 2020
Merged

Conversation

pquentin
Copy link
Member

The first commit runs "twine check". I reused @sethmlarson's code from hip, but simplified it since twine check returns a non-zero error code on failure. You can see the check working as expected here: https://github.com/pquentin/urllib3/runs/593112721?check_suite_focus=true

The second commits fixes the twine warnings by:

  1. removing the raw directive from the long description, and
  2. specifying the content type.

Parsing README.rst is quite brittle, what do you think? It works now (see the resulting PKG-INFO), but who knows how it could break in the future.

Closes #1854

@pquentin
Copy link
Member Author

I hate flaky tests.

Copy link
Member

@sethmlarson sethmlarson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome, thanks for tackling this ❇️
I agree the RST parsing is brittle, at least there is now CI checking for valid RST?

@sethmlarson
Copy link
Member

Codecov action acting up, maybe they should write it in Python instead of NodeJS ;)

@sethmlarson sethmlarson merged commit 299e7b4 into urllib3:master Apr 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Raw HTML in README.rst causing problems with uploading dists
2 participants