Skip to content

project description in pypi docs #1172

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

Merged
merged 1 commit into from
Aug 3, 2021

Conversation

Bowrna
Copy link
Contributor

@Bowrna Bowrna commented Jul 29, 2021

Added long description into setuptools so that it will be added in pypi description

@ghost
Copy link

ghost commented Jul 29, 2021

It looks like @Bowrna hasn't signed our Contributor License Agreement, yet.

The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia

You can read and sign our full Contributor License Agreement here.

Once you've signed reply with [clabot:check] to prove it.

Appreciation of efforts,

clabot

@Bowrna
Copy link
Contributor Author

Bowrna commented Jul 29, 2021

[clabot:check]

@ghost
Copy link

ghost commented Jul 29, 2021

It looks like @Bowrna hasn't signed our Contributor License Agreement, yet.

The purpose of a CLA is to ensure that the guardian of a project's outputs has the necessary ownership or grants of rights over all contributions to allow them to distribute under the chosen licence.
Wikipedia

You can read and sign our full Contributor License Agreement here.

Once you've signed reply with [clabot:check] to prove it.

Appreciation of efforts,

clabot

@Bowrna
Copy link
Contributor Author

Bowrna commented Jul 29, 2021

[clabot:check]

@ghost
Copy link

ghost commented Jul 29, 2021

@confluentinc It looks like @Bowrna just signed our Contributor License Agreement. 👍

Always at your service,

clabot

@Bowrna Bowrna mentioned this pull request Jul 29, 2021
@Bowrna
Copy link
Contributor Author

Bowrna commented Jul 29, 2021

Issue : #1145
I have not run any test to verify this. It would be helpful if someone can tell me how i can test this.

@rbarrois
Copy link

rbarrois commented Aug 2, 2021

@Bowrna I think you can test it using pyroma (pip install pyroma + pyroma .), it would say "The package's long_description is quite short" if the README is missing.

You may also run python setup.py sdist, and check the contents of the PKG-INFO file in the generated tar.gz archive.

By the way, thanks a lot for taking over the issue I had submitted and forgot to take care of 😊

@Bowrna
Copy link
Contributor Author

Bowrna commented Aug 2, 2021

@rbarrois thank you so much your reply. Sure i will do the steps that you have shared and update in this thread.

@mhowlett
Copy link
Contributor

mhowlett commented Aug 2, 2021

thanks for the PR! i noticed this too - definitely need to get it fixed. side note: relevant people are on leave ATM, there may be a delay getting this merged.

@jliunyu
Copy link
Contributor

jliunyu commented Aug 2, 2021

Thanks @Bowrna, I will merge the PR after the test result is updated.

@Bowrna
Copy link
Contributor Author

Bowrna commented Aug 3, 2021

@rbarrois i have tested the PR with pyroma like you have suggested and got the below response. Verified the PKG-INFO file inside .tar.gz file in dist folder. It contains description in it.

------------------------------
Checking .
Found confluent-kafka
------------------------------
Your package does not have keywords data.
------------------------------
Final rating: 9/10
Cottage Cheese
------------------------------

@mhowlett @jliunyu thank you. if there is anything that i have to fix in this PR, please update in this thread.

Copy link
Contributor

@jliunyu jliunyu left a comment

Choose a reason for hiding this comment

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

LGTM

@jliunyu jliunyu linked an issue Aug 3, 2021 that may be closed by this pull request
@jliunyu jliunyu merged commit 23b4142 into confluentinc:master Aug 3, 2021
edenhill added a commit that referenced this pull request Jan 10, 2022
This reverts commit 23b4142.

README.md does not pass readme_renderer, for some reason, and this
blocks sdist uploads to PyPi.
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.

No README on PyPI
4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy