Merge pull request #219 from derek73/ci/codecov-coverage

Add Codecov coverage reporting and README badges

Author: derek73

.github/workflows/python-package.yml

@@ -40,9 +40,16 @@ jobs:
       run: uv run mypy
     - name: Run Tests
       run: |
-        uv run pytest
+        uv run pytest --cov=nameparser --cov-report=xml
         uv run --with build python -m build --sdist
         uv run --with twine twine check dist/*
         uv run sphinx-build -b html docs dist/docs
         uv run sphinx-build -b doctest docs dist/doctest
         uv run python -m doctest README.rst
+    - name: Upload coverage to Codecov
+      if: matrix.python-version == '3.13'
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        fail_ci_if_error: false

README.rst

@@ -1,7 +1,7 @@
 Name Parser
 ===========
 
-|Build Status| |PyPI| |PyPI version| |Documentation|
+|Build Status| |PyPI| |PyPI version| |Documentation| |License| |Downloads| |Codecov|
 
 A simple Python (3.10+) module for parsing human names into their
 individual components. 
@@ -150,3 +150,9 @@ https://github.com/derek73/python-nameparser
    :target: http://nameparser.readthedocs.io/en/latest/?badge=latest
 .. |PyPI version| image:: https://img.shields.io/pypi/pyversions/nameparser.svg
    :target: https://pypi.org/project/nameparser/
+.. |License| image:: https://img.shields.io/pypi/l/nameparser.svg
+   :target: https://pypi.org/project/nameparser/
+.. |Downloads| image:: https://static.pepy.tech/badge/nameparser
+   :target: https://pepy.tech/project/nameparser
+.. |Codecov| image:: https://codecov.io/gh/derek73/python-nameparser/branch/master/graph/badge.svg
+   :target: https://codecov.io/gh/derek73/python-nameparser

pyproject.toml

@@ -45,6 +45,7 @@ dev = [
   "mypy (>=2.1)",
   "ruff (>=0.15)",
   "pytest-timeout>=2.4.0",
+  "pytest-cov>=6",
 ]
 
 [tool.mypy]