chore: added a make command to run code coverage

.gitignore

@@ -9,4 +9,6 @@ dist/
 .idea/
 .env
 ~*
-.vscode/launch.json
+.vscode/launch.json
+coverage.xml
+.coverage

Makefile

@@ -25,6 +25,9 @@ format: install
 test: install
 	poetry run nox -s test $(if $(PYTHON),--python=$(PYTHON),)
 
+coverage: install
+	poetry run nox -s coverage
+
 help:
 	@echo '===================='
 	@echo 'build                        - build the library'

README.md

@@ -149,6 +149,14 @@ Run unit tests for the specific python version:
 make test PYTHON=3.11
 ```
 
+## Code coverage
+
+Run code coverage:
+
+```sh
+make coverage
+```
+
 ## Clean
 
 To remove the virtual environment and build artifacts run:

noxfile.py

@@ -33,6 +33,19 @@ def format(session: nox.Session):
     format_with_args(session, SRC)
 
 
+@nox.session
+def coverage(session: nox.Session) -> None:
+    """Run tests and generate coverage report"""
+    session.run("poetry", "install", external=True)
+    session.run(
+        "pytest",
+        f"--cov={SRC}",
+        "--cov-report=xml",
+        "--cov-report=term",
+    )
+    session.run("coverage", "html", "--data-file=.coverage")
+
+
 @nox.session(python=["3.8", "3.9", "3.10", "3.11", "3.12"])
 # Testing against earliest and latest supported versions of the dependencies
 @nox.parametrize("pydantic", ["1.10.17", "2.8.2"])

pyproject.toml

@@ -53,6 +53,7 @@ telemetry = [
 [tool.poetry.group.test.dependencies]
 pytest = "^8.2"
 pytest-asyncio = "^0.24.0"
+pytest-cov = "^5.0.0"
 nox = "^2023.4.22"
 pillow = "^10.2.0"
 respx = "^0.21.1"
@@ -73,6 +74,19 @@ testpaths = [
     "tests"
 ]
 
+[tool.coverage.run]
+branch = true
+source = ["."]
+omit = [
+    "tests/*",
+    "examples/*",
+    "*/__init__.py",
+    "noxfile.py"
+]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
 [tool.pyright]
 typeCheckingMode = "basic"
 reportUnusedVariable = "error"