Use aux repository data for downloads badge #2832
Conversation
Summary by CodeRabbit
WalkthroughReplaced README's static Pepy total-downloads badge with a dynamic Shields.io YAML-driven badge that reads Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🔇 Additional comments (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 300000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Test build on ubuntu-latest
- GitHub Check: Test build on windows-latest
- GitHub Check: Test build on macos-latest
🔇 Additional comments (1)
README.md (1)
12-12: Badge verification successful
The YAML file is reachable (HTTP 200), themonthly_downloads_humanfield exists (value: “16M”), and the Shields.io badge endpoint returns HTTP 200—badge will render correctly.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #2832 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 286 286
Lines 17038 17038
Branches 2229 2229
=========================================
Hits 17038 17038 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
README.md (2)
12-12: Alt text nit: clarify aux-sourced monthly metric.Make the first badge’s alt precise for screen readers.
Apply this diff:
- <a href="https://pypi.org/project/holidays"><img src="https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvacanza%2Faux%2Frefs%2Fheads%2Fmain%2Fbadges%2Fdownloads%2Fpepy.tech.yaml&query=%24.monthly_downloads_human&suffix=%2Fmonth&style=flat&label=downloads&color=41B5BE&cacheSeconds=86400" alt="PyPI Monthly Downloads"></a> + <a href="https://pypi.org/project/holidays"><img src="https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fvacanza%2Faux%2Frefs%2Fheads%2Fmain%2Fbadges%2Fdownloads%2Fpepy.tech.yaml&query=%24.monthly_downloads_human&suffix=%2Fmonth&style=flat&label=downloads&color=41B5BE&cacheSeconds=86400" alt="PyPI downloads/month (from aux data)"></a>
12-12: Nit: simplify raw.githubusercontent URL (drop refs/heads).Shorter branch path is equivalent and cleaner.
Apply this diff:
-https%3A%2F%2Fraw.githubusercontent.com%2Fvacanza%2Faux%2Frefs%2Fheads%2Fmain%2Fbadges%2Fdownloads%2Fpepy.tech.yaml +https%3A%2F%2Fraw.githubusercontent.com%2Fvacanza%2Faux%2Fmain%2Fbadges%2Fdownloads%2Fpepy.tech.yaml
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (2)
README.md (2)
12-12: Good move: downloads badge now sources from aux via Shields.The dynamic/yaml badge with cacheSeconds looks solid and aligns with the PR goal.
12-12: Aux YAML badge source and key confirmed
The aux YAML at https://raw.githubusercontent.com/vacanza/aux/main/badges/downloads/pepy.tech.yaml returns HTTP 200 and includesmonthly_downloads_human: 16M. No further action needed.
|
Proposed change
Migrate downloads badge to the local data source.
Type of change
holidaysfunctionality in general)Checklist
make checklocally; all checks and tests passed.