Skip to content

Conversation

@blag
Copy link
Contributor

@blag blag commented Oct 27, 2020

This PR improves the PyPI description of st2client by doing the following:

  • Removes the redundant license specifier argument to setup() (see the official documentation on it here, and why this is a problem here)
  • Adds the content of README.rst as the long description for the st2client package on PyPI
  • Adds additional URLs to the project, which I think will be rendered in the sidebar of the PyPI project page, giving the links more visibility for users looking at the st2client package on PyPI

@pull-request-size pull-request-size bot added the size/S PR that changes 10-29 lines. Very easy to review. label Oct 27, 2020
Copy link
Member

@nmaludy nmaludy left a comment

Choose a reason for hiding this comment

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

Should we set long_description_content_type to text/x-rst

https://packaging.python.org/guides/making-a-pypi-friendly-readme/

@blag
Copy link
Contributor Author

blag commented Oct 27, 2020

According to the docs, that's not strictly necessary:

If a Description-Content-Type is not specified, then applications should attempt to render it as text/x-rst; charset=UTF-8 and fall back to text/plain if it is not valid rst.

@blag blag added this to the 3.4.0 milestone Oct 27, 2020
Copy link
Member

@nmaludy nmaludy left a comment

Choose a reason for hiding this comment

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

Great work, thank you!

@blag
Copy link
Contributor Author

blag commented Oct 27, 2020

Thanks for the review!

@blag blag merged commit 632a07e into master Oct 29, 2020
@blag blag deleted the improve-st2client-homepage branch October 29, 2020 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:st2client documentation enhancement size/S PR that changes 10-29 lines. Very easy to review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants