Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Add monthly downloads badge to README #96

Closed Aman-Clement closed 2 months ago

Aman-Clement commented 2 months ago

Added a monthly downloads badge by pip Trends to the README. View more at - https://piptrends.com/widgets/autodocsumm

ixmatus commented 2 months ago

This person tried to open this exact PR against a project I'm the maintainer for as well (https://github.com/ixmatus/inflector/pull/16). This is a promotional campaign and they (or colleagues) appear to be doing it on reddit too, I think this is suspicious activity. They are creating an external dependency on a web property that (as far as I can tell) is not officially blessed by pypi. I recommend rejecting this PR.

Users can get package statistics from libraries.io which is linked to directly by pypi itself.

theOehrly commented 2 months ago

I agree with @ixmatus, and I am against merging this. Using a new provider for this (piptrends.com) feels wrong, especially given the apparent promotional activity around it and given that shields.io, which is established and already used in this project, provides a download counter as well. Additionally, the necessity of this addition is questionable. And judging by the discussions in other PRs, the PyPI download stats may be highly incorrect anyway.

Chilipp commented 2 months ago

Thanks @ixmatus and @theOehrly for your input! I agree and reject this PR. Feel free to add comments and reasons here if you have another opinion

ayushjain01 commented 2 months ago

Thank you for your feedback and concerns. I'd like to clarify that this is not a promotional campaign. As stated in the PR description, our intention is simply to share a tool we have developed, which we believe could be beneficial to the community.

Our badge system offers highly accurate statistics, which is why we wanted to make it available. If the link to the pip trends page is a concern, we are more than willing to remove it.

We respect your decision if you prefer not to add more badges to your README. Our primary goal is to address any misunderstandings and assure you that this is a genuine effort to contribute to the open-source community by sharing our work on GitHub.

Thank you for considering our contribution.