Skip to content

Commit

Permalink
📝 Add docs about reporting coverage in HTML (fastapi#161)
Browse files Browse the repository at this point in the history
  • Loading branch information
tiangolo authored Apr 20, 2020
1 parent ffc4ec6 commit edb3feb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,22 @@ For example, to stop on first error:
docker-compose exec backend bash /app/tests-start.sh -x
```

#### Test Coverage

Because the test scripts forward arguments to `pytest`, you can enable test coverage HTML report generation by passing `--cov-report=html`.

To run the local tests with coverage HTML reports:

```Bash
DOMAIN=backend sh ./scripts/test-local.sh --cov-report=html
```

To run the tests in a running stack with coverage HTML reports:

```bash
docker-compose exec backend bash /app/tests-start.sh --cov-report=html
```

### Live development with Python Jupyter Notebooks

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

0 comments on commit edb3feb

Please sign in to comment.