Skip to content

Conversation

jaseemjaskp
Copy link
Contributor

Summary

This PR adds three new badges to the README to improve project visibility and showcase modern development practices.

Changes

  • PyPI Downloads Badge: Displays monthly download statistics from PyPI
  • uv Badge: Highlights the use of uv for fast Python package management
  • Ruff Badge: Showcases code quality tooling with Ruff for linting and formatting

Motivation

Adding these badges helps:

  • Showcase package popularity through PyPI download metrics
  • Highlight modern tooling being used in the project (uv + Ruff)
  • Improve project credibility and demonstrate commitment to code quality
  • Increase visibility for potential users and contributors

Related Issues

N/A - This is an enhancement to improve project presentation.

Testing

  • ✅ Pre-commit hooks passed (prettier, file checks)
  • ✅ No breaking changes to existing functionality
  • ✅ Badges display correctly in GitHub markdown

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Documentation updated (README badges)
  • No breaking changes introduced
  • Pre-commit hooks pass
  • Badges are properly formatted and functional

Screenshots

The new badges will appear after the existing Python version, License, and Build Status badges:

[![PyPI Downloads](https://img.shields.io/pypi/dm/apihub-python-client)](https://pypi.org/project/apihub-python-client/)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

- Add PyPI downloads badge to showcase package popularity
- Add uv badge to highlight modern Python package management
- Add Ruff badge to showcase code quality tooling
- Improves project visibility and demonstrates modern development practices
@jaseemjaskp jaseemjaskp added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 25, 2025
@github-actions
Copy link
Contributor

🧪 Test Report

Test Results

Test Environment

  • Python Version: 3.12
  • OS: Ubuntu Latest
  • Tox Environment: py312

Status

✅ All tests passed successfully!

@jaseemjaskp jaseemjaskp merged commit 58134f1 into main Jul 25, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant