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

Add monthly downloads badge to README #215

Closed
wants to merge 1 commit into from

Conversation

ayushjain01
Copy link

@ayushjain01 ayushjain01 commented Jun 12, 2024

Just a suggestion. I've been working on developing a badge system for Python packages to display statistics like monthly downloads. You can check it out at - https://piptrends.com/package/mapclassify.

Our goal at Pip Trends is to create a learning forum where developers can access everything they need to get started with Python and Python packages.

The badge links to the mapclassify page on Pip Trends, showcasing various stats and documentation. We plan to add simple getting-started articles and more to this page soon, and contributions are welcome. If necessary, this link can be removed. This PR is just to share the badge we have created.

@martinfleis
Copy link
Member

Thanks! Though I am not sure I am in favour.

If we want a badge showing number of downloads I would rather suggest using shields.io option as we do with other badges. That also ensures it looks the same. And the link shall probably go to PyPI.

This PR feels more like a way of getting piptrends into the wild rather than an improvement of our Readme.

@ayushjain01
Copy link
Author

Understandable, like i mentioned earlier, this is just a suggestion and we just want to share something we built. Also about the link to piptrends.com, like I mentioned can be removed if needed.
The goal is to only share something we have built and nothing else.

About using shields.io, I believe their counts are a little inconsistent compared to the actual counts. (The download counts differ by a margin of ~6k)

PyPI - Downloads
mapclassify Downloads Last Month

Our count matches the following query:

SELECT COUNT(*) AS num_downloads
FROM `bigquery-public-data.pypi.file_downloads`
WHERE file.project = 'sqlalchemy'
  -- Only query the last 30 days of history
  AND DATE(timestamp)
    BETWEEN DATE_SUB(CURRENT_DATE(), INTERVAL 30 DAY)
    AND CURRENT_DATE()

Not quite sure why the shield.io badge has inconsistent counts, but it's the same across all packages. You can refer to the Python Packaging User Guide for more information.

@ixmatus
Copy link

ixmatus commented Jun 27, 2024

@martinfleis a colleague of this person tried to open this exact PR against a project I'm the maintainer for as well (ixmatus/inflector#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.

@martinfleis
Copy link
Member

@ixmatus Well said.

@ayushjain01
Copy link
Author

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.

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.

3 participants