Skip to content

Commit b88a0fc

Browse files
authored
📝 Add docs about reporting coverage in HTML (#161)
1 parent b02e463 commit b88a0fc

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

{{cookiecutter.project_slug}}/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,22 @@ For example, to stop on first error:
174174
docker-compose exec backend bash /app/tests-start.sh -x
175175
```
176176

177+
#### Test Coverage
178+
179+
Because the test scripts forward arguments to `pytest`, you can enable test coverage HTML report generation by passing `--cov-report=html`.
180+
181+
To run the local tests with coverage HTML reports:
182+
183+
```Bash
184+
DOMAIN=backend sh ./scripts/test-local.sh --cov-report=html
185+
```
186+
187+
To run the tests in a running stack with coverage HTML reports:
188+
189+
```bash
190+
docker-compose exec backend bash /app/tests-start.sh --cov-report=html
191+
```
192+
177193
### Live development with Python Jupyter Notebooks
178194

179195
If you know about Python [Jupyter Notebooks](http://jupyter.org/), you can take advantage of them during local development.

0 commit comments

Comments
 (0)