tests coverage reporting

[MaaniBeigy]

🚀 Feature Request

Tests coverage reporting.

🔈 Motivation

I found it in your ToDos. I implemented it for my own package pycvcqv using pytest-cov, coverage-badge, and, pytest-html .

🛰 Alternatives

To implement such a solution:

1. first, edit your pyproject.toml:

[tool.poetry.dev-dependencies]
coverage = "*"
coverage-badge = "*"
pytest-html = "*"
pytest-cov = "*"

[tool.coverage.run]
source = ['package_name', 'tests_folder']

[coverage.paths]

source = 'package_name'

[coverage.run]
branch = true

[coverage.report]
fail_under = 50
show_missing = true

2. next, mkdir assets/images/.
3. Then, add these lines to Makefile:

.PHONY: coverage
coverage:
	poetry run pytest --cov-report html --cov packagename tests/
	poetry run coverage-badge -o assets/images/coverage.svg -f

4. Then, run these lines:

make install
make test && make coverage && make check-codestyle && make mypy && make check-safety

5. Finally, add this to the README.md:

[![coverage report](assets/images/coverage.svg)]

You, will have something like .

📎 Additional context

More importantly, you can open htmlcov/index.html in your browser and observe the covered/uncovered codes.

[TezRomacH]

Thanks so much! It works like magic!

I have added coverage inside make test command

You now may try to create new package

cookiecutter gh:TezRomacH/python-package-template --checkout v1.1.1

[TezRomacH]

Also i have added you as a contributor in the version release notes
https://github.com/TezRomacH/python-package-template/releases/tag/v1.1.1

Thanks again, it was really helpful feature :)