Enable code coverage with Codecov

kuchtact / WiPPLPy

Easily access data from plasma devices in the Wisconsin Plasma Physics Laboratory (WiPPL).

https://wipplpy.readthedocs.io/en/latest/

2 stars 4 forks source link

Enable code coverage with Codecov #11

Open namurphy opened 1 year ago

namurphy commented 1 year ago

Code coverage tools identify which lines of code are run at least once when tests are run, and which lines of code are untested. Code coverage is a good way to see where new tests are needed, and it can also help us identify sections of code that cannot be reached. We should enable code coverage for WiPPLPy, and make it so that the repo gets connected to Codecov.

kuchtact commented 2 months ago

[x] Add repository token.
[x] Add pytest-cov to install requirements.
[ ] Add code coverage option to nox testing as can be seen here: https://github.com/PlasmaPy/PlasmaPy/blob/1385eb49d59e8a50a997187d47aec02c82ef2a04/noxfile.py#L200-L201
[x] Upload the code coverage: https://github.com/PlasmaPy/PlasmaPy/blob/1385eb49d59e8a50a997187d47aec02c82ef2a04/.github/workflows/ci.yml#L105-L112