Add code test coverage badge to README - Githubissues

retroam / Calcium-analysis

Python implementation of calcium imaging analysis pipeline for cardiac myocytes

0 stars 0 forks source link

Add code test coverage badge to README #34

Closed sweep-ai[bot] closed 1 year ago

sweep-ai[bot] commented 1 year ago

Description

This PR adds a code test coverage badge to the README file.

Changes Made

Added a code coverage tool, coverage.py, to the requirements.txt file.
Modified the test scripts to use coverage.py when running the tests.
Created a .coveralls.yml file to configure the coverage reporting service.
Added a code coverage badge to the README file.

How to Test

Clone the repository.
Install the required dependencies by running pip install -r requirements.txt.
Run the tests with coverage by executing coverage run -m pytest.
Verify that the coverage report is generated and the badge is displayed correctly in the README file.

Related Issue

Checklist

[ ] Updated the README file.
[ ] Added coverage to the requirements.txt file.
[ ] Modified the test scripts to use coverage.py.
[ ] Created a .coveralls.yml file.
[ ] Verified that the coverage report is generated and the badge is displayed correctly in the README file.

Fixes #32.

To checkout this PR branch, run the following command in your terminal:

git checkout sweep/add-coverage-badge