Skip to content

docs: add PyPI downloads badge to the README - #361

Merged
Jeomon merged 1 commit into
mainfrom
docs/pypi-downloads-badge
Aug 1, 2026
Merged

docs: add PyPI downloads badge to the README#361
Jeomon merged 1 commit into
mainfrom
docs/pypi-downloads-badge

Conversation

@Jeomon

@Jeomon Jeomon commented Aug 1, 2026

Copy link
Copy Markdown
Member

Adds the pepy.tech downloads badge (currently reading 194k).

Placement

First badge row, after Last Commit and before the <br> that separates project badges from the social ones:

license | python | platform | last-commit | downloads
---
twitter | discord

It is a project statistic, so it groups with last-commit rather than with the Twitter/Discord links.

Formatting

Written as <a><img> rather than markdown, because the surrounding <div align="center"> is raw HTML and every other badge in that block uses the same form — markdown image syntax is unreliable inside an HTML block without surrounding blank lines.

The query string uses &amp; for the same reason the trendshift badge directly below it does.

Verified the badge URL returns 200 image/svg+xml.

Placed in the first badge row alongside license, Python, platform and
last-commit, before the <br> that separates project badges from the
social ones -- it is a project statistic, so it groups with last-commit
rather than with the Twitter/Discord links.

Written as <a><img> to match every other badge in that block rather than
as markdown, since the surrounding <div align="center"> is raw HTML, and
the query string uses &amp; for the same reason the trendshift badge
below it does.
@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Add PyPI downloads badge to README

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Add pepy.tech total-downloads badge to the primary README badge row.
• Keep badges in consistent HTML ` form inside the centered `.
• Encode query params with &amp; for valid HTML attribute parsing.
Diagram

graph TD
  readme["README.md"] --> pepy{{"pepy.tech"}} --> badge{{"static.pepy.tech"}}
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Use a shields.io downloads badge
  • ➕ Keeps all badges on a single provider (shields.io)
  • ➕ Often simpler URLs and styling consistency with other shields
  • ➖ May not provide the same totals/source as pepy.tech
  • ➖ Badges can be less stable depending on upstream endpoints
2. Use PyPI stats via another provider (e.g., pypistats)
  • ➕ More direct alignment with a specific stats API/provider
  • ➕ Can choose different metrics (last month/week) more explicitly
  • ➖ May require different rendering/badge hosting
  • ➖ Can introduce rate-limit or reliability concerns

Recommendation: Keep the current pepy.tech badge approach: it matches the existing raw-HTML badge block style (``), uses correct HTML escaping (&amp;amp;), and cleanly groups downloads with other project statistics rather than social links.

Files changed (1) +3 / -0

Documentation (1) +3 / -0
README.mdAdd pepy.tech PyPI downloads badge to the badge header +3/-0

Add pepy.tech PyPI downloads badge to the badge header

• Adds a new downloads badge (pepy.tech) in the first badge row next to other project stats. The badge is embedded using HTML '<a><img>' and uses '&amp;'-escaped query parameters for correctness within the HTML block.

README.md

@Jeomon
Jeomon merged commit 41616c9 into main Aug 1, 2026
2 checks passed
@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 16 rules

Grey Divider


Remediation recommended

1. Long img src URL 📘 Rule violation ✧ Quality
Description
The added Pepy badge img line exceeds the 100-character maximum line length. This can reduce
readability and violates the repo’s line-length compliance rule.
Code

README.md[11]

+    <img src="https://static.pepy.tech/personalized-badge/windows-mcp?period=total&amp;units=INTERNATIONAL_SYSTEM&amp;left_color=BLACK&amp;right_color=GREEN&amp;left_text=downloads" alt="PyPI Downloads">
Relevance

●● Moderate

Line-length fixes accepted (#307) / partially (#353) but also rejected (#329); no README-specific
line-length precedent found.

PR-#307
PR-#353
PR-#329

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
PR Compliance ID 222796 requires all non-comment, non-whitespace lines to be 100 characters or
fewer. The newly added <img src=...> line contains a long URL with multiple query parameters,
pushing the line beyond this limit.

Rule 222796: Enforce maximum line length of 100 characters
README.md[11-11]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
A newly added line in `README.md` exceeds the 100-character maximum line length due to a very long badge `src` URL.

## Issue Context
This PR adds a Pepy downloads badge using a `personalized-badge` URL with a long query string, resulting in a line-length compliance violation.

## Fix Focus Areas
- README.md[10-12]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

To customize comments, go to the Qodo configuration screen, or learn more in the docs.

Qodo Logo

Comment thread README.md
<img src="https://img.shields.io/badge/platform-Windows%207–11-blue" alt="Platform: Windows 7 to 11">
<img src="https://img.shields.io/github/last-commit/CursorTouch/Windows-MCP" alt="Last Commit">
<a href="https://pepy.tech/projects/windows-mcp">
<img src="https://static.pepy.tech/personalized-badge/windows-mcp?period=total&amp;units=INTERNATIONAL_SYSTEM&amp;left_color=BLACK&amp;right_color=GREEN&amp;left_text=downloads" alt="PyPI Downloads">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Remediation recommended

1. Long img src url 📘 Rule violation ✧ Quality

The added Pepy badge img line exceeds the 100-character maximum line length. This can reduce
readability and violates the repo’s line-length compliance rule.
Agent Prompt
## Issue description
A newly added line in `README.md` exceeds the 100-character maximum line length due to a very long badge `src` URL.

## Issue Context
This PR adds a Pepy downloads badge using a `personalized-badge` URL with a long query string, resulting in a line-length compliance violation.

## Fix Focus Areas
- README.md[10-12]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

@Jeomon
Jeomon deleted the docs/pypi-downloads-badge branch August 1, 2026 07:50
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.

1 participant