test: add coverage

Author: remarkablemark

.github/CONTRIBUTING.md

@@ -98,7 +98,23 @@ Run the tests:
 pytest
 ```
 
-Install the package with `pipx`:
+Run the tests with [coverage](https://coverage.readthedocs.io/):
+
+```sh
+coverage run -m pytest
+```
+
+Generate a coverage report:
+
+```sh
+coverage report
+```
+
+```sh
+coverage html
+```
+
+Install the package with [pipx](https://pipx.pypa.io/):
 
 ```sh
 pipx install .

.github/workflows/test.yml

@@ -20,5 +20,13 @@ jobs:
       - name: Install dependencies
         run: pip install -e .[test]
 
-      - name: Run pytest
-        run: pytest
+      - name: Run tests and collect coverage
+        run: |
+          coverage run -m pytest
+          coverage report
+          coverage xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -1,7 +1,7 @@
 # python_cli_template
 
 [![PyPI version](https://badgen.net/pypi/v/python_cli_template)](https://pypi.org/project/python_cli_template/)
-[![test](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/python_cli_template/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/remarkablemark/python_cli_template/graph/badge.svg?token=l6pg0nf9aJ)](https://codecov.io/gh/remarkablemark/python_cli_template)
 [![lint](https://github.com/remarkablemark/python_cli_template/actions/workflows/lint.yml/badge.svg)](https://github.com/remarkablemark/python_cli_template/actions/workflows/lint.yml)
 
 🐍 Python CLI Template

pyproject.toml

@@ -28,6 +28,7 @@ build = [
 ]
 test = [
     "black==25.1.0",
+    "coverage==7.7.1",
     "isort==6.0.1",
     "pre-commit==4.2.0",
     "pytest==8.3.5",

src/python_cli_template/cli.py

@@ -34,5 +34,5 @@ def main(argv: list[str] = None) -> None:
     print(f"{color}{hello(args.name)}")
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: no cover
     main()