Merge pull request #36 from t-strings/dave/coverage-badge

Add test count and coverage badges to README

Author: davepeck

.github/workflows/pages.yml

@@ -22,7 +22,7 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Build Sphinx documentation
+    name: Build Sphinx documentation and Special Badges
     steps:
       - uses: actions/checkout@v4
 
@@ -39,6 +39,20 @@ jobs:
           cd docs
           uv run sphinx-build . _build
 
+      - name: Generate reports
+        run: |
+          mkdir -p reports
+          uv run pytest --cov=tdom --cov-report=xml:reports/coverage.xml --cov-report=term --cov-report=html:reports/coverage --junitxml=reports/pytest.xml --html=reports/pytest.html
+
+      - name: Generate badges
+        run: |
+          uv run genbadge tests -i reports/pytest.xml -v -o reports/pytest.svg
+          uv run genbadge coverage -i reports/coverage.xml -v -o reports/coverage.svg
+
+      - name: Move reports to docs/_build
+        run: |
+          mv reports docs/_build/
+
       - name: Upload artifact to pages
         uses: actions/upload-pages-artifact@v3
         with:

.gitignore

@@ -9,8 +9,12 @@ wheels/
 # Virtual environments
 .venv
 
-# Coverage
+# Coverage and test reports
 .coverage
+reports/
 
 # Sphinx build output
 docs/_build/
+
+# macOS
+.DS_Store

README.md

@@ -4,8 +4,11 @@ A 🤘 rockin' t-string HTML templating system for Python 3.14.
 
 [![PyPI](https://img.shields.io/pypi/v/tdom.svg)](https://pypi.org/project/tdom/)
 [![Tests](https://github.com/t-strings/tdom/actions/workflows/ci.yml/badge.svg)](https://github.com/t-strings/tdom/actions/workflows/pytest.yml)
+[![Test Count](https://t-strings.github.io/tdom/reports/pytest.svg)](https://t-strings.github.io/tdom/reports/pytest.html)
+[![Coverage](https://t-strings.github.io/tdom/reports/coverage.svg)](https://t-strings.github.io/tdom/reports/coverage.html)
 [![Changelog](https://img.shields.io/github/v/release/t-strings/tdom?include_prereleases&label=changelog)](https://github.com/t-strings/tdom/releases)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/t-strings/tdom/blob/main/LICENSE)
+[![Docs](https://img.shields.io/badge/docs-online-blue.svg)](https://t-strings.github.io/tdom/)
 
 ## Installation
 

justfile

@@ -31,3 +31,16 @@ clean_package:
 build: build_docs build_package
 
 clean: clean_docs clean_package
+
+reports:
+    uv run pytest --cov=tdom --cov-report=xml:reports/coverage.xml --cov-report=term --cov-report=html:reports/coverage --junitxml=reports/pytest.xml --html=reports/pytest.html
+
+clean_reports:
+    rm -rf reports/
+
+badges:
+    uv run genbadge tests -i reports/pytest.xml -v -o reports/pytest.svg
+    uv run genbadge coverage -i reports/coverage.xml -v -o reports/coverage.svg
+
+clean_badges:
+    rm -rf reports/*.svg

pyproject.toml

@@ -37,10 +37,12 @@ CI = "https://github.com/t-strings/tdom/actions"
 [dependency-groups]
 dev = [
   "furo>=2025.7.19",
+  "genbadge[coverage,tests]>=1.1.2",
   "myst-parser>=4.0.1",
   "pyright>=1.1.404",
   "pytest>=8.4.1",
   "pytest-cov>=6.3.0",
+  "pytest-html>=4.1.1",
   "pytest-watcher>=0.4.3",
   "ruff>=0.12.11",
   "sphinx>=8.2.3",