From 07cc0276f29c881ddbd1cdd25006d522d962ca5d Mon Sep 17 00:00:00 2001 From: Jonathan Tsai Date: Thu, 6 Nov 2025 16:32:29 -0800 Subject: [PATCH] docs: add quality and maintenance badges to README files Add comprehensive badge set to both README.md and README.rst to signal project quality, maintenance status, and community standards. Badges added: - Build Status: CI/CD pipeline status from GitHub Actions - PyPI Version: Latest package version on PyPI - Python Versions: Supported Python versions (3.9-3.12, PyPy) - License: MIT license badge - Ruff: Modern Python linter for code quality - Maintained: Active development indicator Badges preserved from original README.rst: - Documentation Status: ReadTheDocs build status - Coverage: Code coverage from codecov These badges help users quickly assess: - Project stability and CI health - Package availability and compatibility - Code quality standards - Active maintenance and support --- README.md | 8 ++++++++ README.rst | 37 ++++++++++++++++++++++--------------- 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index dc8b4b53..149b6d6b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ +# DataPilot CLI + +[![Build Status](https://github.com/AltimateAI/datapilot-cli/workflows/build/badge.svg)](https://github.com/AltimateAI/datapilot-cli/actions) +[![PyPI version](https://badge.fury.io/py/altimate-datapilot-cli.svg)](https://pypi.org/project/altimate-datapilot-cli/) +[![Python Version](https://img.shields.io/pypi/pyversions/altimate-datapilot-cli.svg)](https://pypi.org/project/altimate-datapilot-cli/) +[![License](https://img.shields.io/github/license/AltimateAI/datapilot-cli.svg)](https://github.com/AltimateAI/datapilot-cli/blob/main/LICENSE) +[![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) +[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/AltimateAI/datapilot-cli/graphs/commit-activity) ## Introduction diff --git a/README.rst b/README.rst index 2b78c72a..f5388583 100644 --- a/README.rst +++ b/README.rst @@ -4,32 +4,39 @@ Overview .. start-badges -.. list-table:: - :stub-columns: 1 - - * - docs - - |docs| - * - tests - - | |github-actions| - | |codecov| - | |scrutinizer| - * - package - - | |version| |wheel| |supported-versions| |supported-implementations| - | |commits-since| .. |docs| image:: https://readthedocs.org/projects/datapilot/badge/?style=flat :target: https://datapilot.readthedocs.io/ :alt: Documentation Status -.. |github-actions| image:: https://github.com/AltimateAI/datapilot-cli/actions/workflows/github-actions.yml/badge.svg - :alt: GitHub Actions Build Status - :target: https://github.com/AltimateAI/datapilot/actions +.. |build| image:: https://github.com/AltimateAI/datapilot-cli/workflows/build/badge.svg + :target: https://github.com/AltimateAI/datapilot-cli/actions + :alt: Build Status .. |codecov| image:: https://codecov.io/gh/anandgupta42/datapilot/branch/main/graphs/badge.svg?branch=main :alt: Coverage Status :target: https://app.codecov.io/github/anandgupta42/datapilot +.. |pypi| image:: https://badge.fury.io/py/altimate-datapilot-cli.svg + :target: https://pypi.org/project/altimate-datapilot-cli/ + :alt: PyPI Package + +.. |pyversion| image:: https://img.shields.io/pypi/pyversions/altimate-datapilot-cli.svg + :target: https://pypi.org/project/altimate-datapilot-cli/ + :alt: Python Versions + +.. |license| image:: https://img.shields.io/github/license/AltimateAI/datapilot-cli.svg + :target: https://github.com/AltimateAI/datapilot-cli/blob/main/LICENSE + :alt: License + +.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Ruff +.. |maintained| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg + :target: https://github.com/AltimateAI/datapilot-cli/graphs/commit-activity + :alt: Maintained +|docs| |build| |codecov| |pypi| |pyversion| |license| |ruff| |maintained| .. end-badges