Skip to content

Commit 17f59e0

Browse files
authored
docs: add quality and maintenance badges to README files (#88)
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
1 parent d7aa752 commit 17f59e0

File tree

2 files changed

+30
-15
lines changed

2 files changed

+30
-15
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# DataPilot CLI
2+
3+
[![Build Status](https://github.com/AltimateAI/datapilot-cli/workflows/build/badge.svg)](https://github.com/AltimateAI/datapilot-cli/actions)
4+
[![PyPI version](https://badge.fury.io/py/altimate-datapilot-cli.svg)](https://pypi.org/project/altimate-datapilot-cli/)
5+
[![Python Version](https://img.shields.io/pypi/pyversions/altimate-datapilot-cli.svg)](https://pypi.org/project/altimate-datapilot-cli/)
6+
[![License](https://img.shields.io/github/license/AltimateAI/datapilot-cli.svg)](https://github.com/AltimateAI/datapilot-cli/blob/main/LICENSE)
7+
[![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)
8+
[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/AltimateAI/datapilot-cli/graphs/commit-activity)
19

210
## Introduction
311

README.rst

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,39 @@ Overview
44

55
.. start-badges
66
7-
.. list-table::
8-
:stub-columns: 1
9-
10-
* - docs
11-
- |docs|
12-
* - tests
13-
- | |github-actions|
14-
| |codecov|
15-
| |scrutinizer|
16-
* - package
17-
- | |version| |wheel| |supported-versions| |supported-implementations|
18-
| |commits-since|
197
.. |docs| image:: https://readthedocs.org/projects/datapilot/badge/?style=flat
208
:target: https://datapilot.readthedocs.io/
219
:alt: Documentation Status
2210

23-
.. |github-actions| image:: https://github.com/AltimateAI/datapilot-cli/actions/workflows/github-actions.yml/badge.svg
24-
:alt: GitHub Actions Build Status
25-
:target: https://github.com/AltimateAI/datapilot/actions
11+
.. |build| image:: https://github.com/AltimateAI/datapilot-cli/workflows/build/badge.svg
12+
:target: https://github.com/AltimateAI/datapilot-cli/actions
13+
:alt: Build Status
2614

2715
.. |codecov| image:: https://codecov.io/gh/anandgupta42/datapilot/branch/main/graphs/badge.svg?branch=main
2816
:alt: Coverage Status
2917
:target: https://app.codecov.io/github/anandgupta42/datapilot
3018

19+
.. |pypi| image:: https://badge.fury.io/py/altimate-datapilot-cli.svg
20+
:target: https://pypi.org/project/altimate-datapilot-cli/
21+
:alt: PyPI Package
22+
23+
.. |pyversion| image:: https://img.shields.io/pypi/pyversions/altimate-datapilot-cli.svg
24+
:target: https://pypi.org/project/altimate-datapilot-cli/
25+
:alt: Python Versions
26+
27+
.. |license| image:: https://img.shields.io/github/license/AltimateAI/datapilot-cli.svg
28+
:target: https://github.com/AltimateAI/datapilot-cli/blob/main/LICENSE
29+
:alt: License
30+
31+
.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
32+
:target: https://github.com/astral-sh/ruff
33+
:alt: Ruff
3134

35+
.. |maintained| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
36+
:target: https://github.com/AltimateAI/datapilot-cli/graphs/commit-activity
37+
:alt: Maintained
3238

39+
|docs| |build| |codecov| |pypi| |pyversion| |license| |ruff| |maintained|
3340

3441
.. end-badges
3542

0 commit comments

Comments
 (0)