Skip to content

docs: add PyPI, Python version, downloads, and docs badges to README#6023

Open
zichen0116 wants to merge 2 commits into
google:mainfrom
zichen0116:docs/add-readme-badges
Open

docs: add PyPI, Python version, downloads, and docs badges to README#6023
zichen0116 wants to merge 2 commits into
google:mainfrom
zichen0116:docs/add-readme-badges

Conversation

@zichen0116

Copy link
Copy Markdown

Summary

Add shields.io badges to the README to improve project discoverability and provide quick metadata at a glance.

Badges added:

  • PyPI version — links to the google-adk package page
  • Python versions — shows supported Python versions (3.10+)
  • Monthly downloads — displays PyPI download count
  • Documentation — links to the official docs at adk-docs

Before

Only the License badge was present.

After

README header now shows License, PyPI version, Python versions, downloads, and docs badges — consistent with other Google open-source Python projects.

@google-cla

google-cla Bot commented Jun 8, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@adk-bot adk-bot added the documentation [Component] This issue is related to documentation, it will be transferred to adk-docs label Jun 8, 2026
@adk-bot

adk-bot commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

Response from ADK Triaging Agent

Hello @zichen0116, thank you for creating this PR!

We noticed that the Google Contributor License Agreement (CLA) check has failed for this pull request. According to our contribution guidelines, all contributors must sign the Google CLA before we can accept and review your pull request.

Could you please visit https://cla.developers.google.com/ to sign the agreement?

Once you have signed it, the check should automatically update. This will help our team review and merge your contribution as soon as possible. Thank you!

Add shields.io badges for PyPI version, supported Python versions,
monthly downloads, and documentation link to improve discoverability
and provide quick project metadata at a glance.
@zichen0116 zichen0116 force-pushed the docs/add-readme-badges branch from 1ef2312 to a39fcac Compare June 9, 2026 10:56
@adk-bot

adk-bot commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

I will read the instructions for the adk-pr-analyze skill, as the user has explicitly requested the /adk-pr-analyze 6023 command.I will run the Contributor License Agreement (CLA) verification script for PR 6023.I will fetch the details of Pull Request 6023 using the custom GitHub PR fetch tool.I will make a clean call to fetch PR 6023 details using only pr_number.I will verify the status of the PRchecks, particularly the Google CLA check, using the gh CLI.I will fetch the complete diff for PR 6023 to review the incoming changes.I will view the contents of the README.md file to verify its current state and structure.I will create the analysis report as an artifact to store it persistently.I have completed the read-only triage and analysis of Pull Request #6023.

🛡️ Contributor License Agreement (CLA) Verification

Before performing any analysis, I retrieved the PR details and verified the CLA signature status of the contributor.

  • cla/google status: pass
  • The contributor's CLA is signed and approved.

The completed analysis report has been saved as an artifact at pr_6023_analysis.md. The full analysis is provided below:


🔍 ADK Pull Request Analysis: PR #6023

Title: docs: add PyPI, Python version, downloads, and docs badges to README
Author: @zichen0116
Status: open
Impact: 4 additions, 0 deletions across 1 files

Executive Summary

  1. Core Objective: Add PyPI metadata badges (version, python compatibility, monthly downloads) and documentation shield to the README.md to enhance visibility, metadata access, and official reference links.
  2. Justification & Value: [Valuable Feature] - Provides standard metadata badges in the package's primary entry point, making it consistent with other professional Google Python open-source repositories.
  3. Alignment with Principles: [Pass] - Follows README and documentation best practices with no impact on source code or public/private APIs.
  4. Recommendation: [Approve]
Detailed Findings & Analysis

1. Objectives & Impact ("What does it do?")

  • Context & Background: Currently, the homepage of the repository only includes a License badge, missing standard indicators about PyPI release statuses, supported Python version matrices, download statistics, and links to official documentation.
  • Implementation Mechanism: Modifies the root README.md file to introduce 4 new standard SVG badges from shields.io.
  • Affected Surface: No changes to public code modules, CLI interfaces, package schemas, state models, or setup workflows.

2. Justification & Value ("Is it a valid and useful change?")

  • Workspace Verification:
    • Investigated current workspace files: README.md (using view_file / run_command).
    • Found that: Only the license badge [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) was configured initially in line 3.
  • Value Assessment: These key stats badges are essential for increasing reliability and developer trust. They help potential users immediately gauge the library's stability, compatibility (3.10+), support status, and where to find comprehensive documentation without searching deep in files or search engines.
  • Alternative Approaches: Code-wise there's no cleaner alternative. The source links point to standard PyPI URLs under the official google-adk key and doc-site pages.
  • Scope & Depth: [Systematic Fix] & [Root Cause] - Elegantly updates metadata across the root repository entrance page.

3. Principle & Style Alignment Checklist ("Does it follow rules?")

  • Public API & Visibility Boundaries:
    • Status: [Pass]
    • Analysis: Completely non-functional changes. No risk of API breakage or structural changes.
  • Code Quality, Typing & Conventions:
    • Status: [Pass]
    • Analysis: Links to URLs are clean and properly structured. Badges align cleanly with the design.
  • Robustness & Edge Cases:
    • Status: [Pass]
    • Analysis: Badge SVGs scale well across mobile and desktop Markdown viewers.
  • Test Integrity & Quality:
    • Status: [N/A]
    • Analysis: Documentation changes do not require unit tests.

@rohityan rohityan self-assigned this Jun 9, 2026
@rohityan rohityan added the needs review [Status] The PR/issue is awaiting review from the maintainer label Jun 9, 2026
@rohityan rohityan requested a review from GWeale June 9, 2026 18:38
@rohityan

rohityan commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Hi @zichen0116 , Thank you for your contribution! We appreciate you taking the time to submit this pull request. Your PR has been received by the team and is currently under review. We will provide feedback as soon as we have an update to share.

@rohityan

rohityan commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Hi @GWeale , can you please review this. LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation [Component] This issue is related to documentation, it will be transferred to adk-docs needs review [Status] The PR/issue is awaiting review from the maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants