Add coverage badge

Author: phumthep

.github/workflows/python-app.yml

@@ -19,21 +19,44 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:
         python-version: "3.10"
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install flake8
         pip install .
+
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --ignore=E501,F401,W503,E266 --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --ignore=E501,F401,W503,E266 --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with unittest
+
+    - name: Unit testing
       run: |
-        python -m unittest discover src/test_pownet
+        coverage run -m unittest discover src/test_pownet
+        coverage json
+        COVERAGE_PERCENT=$(python -c "import json; print(json.load(open('coverage.json'))['totals']['percent_covered_display'])")
+        echo "Total Coverage: $COVERAGE_PERCENT%"
+        echo "total=$COVERAGE_PERCENT" >> $GITHUB_ENV
+    
+    - name: Code coverage
+      uses: schneegans/[email protected]
+      with:
+        auth: ${{ secrets.GIST_TOKEN }}
+        gistID: 23c151ad08ede7f698ce7cfbc2c09a0a
+        filename: covbadge.json
+        label: Coverage
+        message: ${{ env.total }}%
+        minColorRange: 50
+        maxColorRange: 90
+        valColorRange: ${{ env.total }}
+
+        
+

README.md

@@ -1,5 +1,6 @@
 ![license MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
 [![CI Tests](https://github.com/Critical-Infrastructure-Systems-Lab/PowNet/actions/workflows/python-app.yml/badge.svg)](https://github.com/Critical-Infrastructure-Systems-Lab/PowNet/actions)
+[![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/phumthep/23c151ad08ede7f698ce7cfbc2c09a0a/raw/covbadge.json)](https://github.com/Critical-Infrastructure-Systems-Lab/PowNet/actions)
 [![GitHub Release](https://img.shields.io/github/v/release/Critical-Infrastructure-Systems-Lab/PowNet)](https://github.com/Critical-Infrastructure-Systems-Lab/PowNet/releases/tag/v2.0)
 [![Read the Docs](https://img.shields.io/readthedocs/pownet)](https://pownet.readthedocs.io/en/latest/)
 [![status](https://joss.theoj.org/papers/f7509a62fde550bec7ae3d1da0181b7d/status.svg)](https://joss.theoj.org/papers/f7509a62fde550bec7ae3d1da0181b7d)

pyproject.toml

@@ -8,6 +8,9 @@ where = ["src"]
 [tool.setuptools.package-data]
 pownet = ["database/*.csv"]
 
+[tool.coverage.run]
+disable_warnings = ["no-data-collected"]
+
 [project]
 name = "pownet"
 version = "2.2.0"
@@ -28,6 +31,7 @@ dependencies = [
     "statsmodels >= 0.14.4",
     "geopandas >= 1.0.1",
     "contextily >= 1.6.2",
+    "coverage >= 7.8.0",
 ]
 requires-python = ">=3.10"