Skip to content

Commit

Permalink
Update skeleton description to incorporate diff-cover. Ref #90.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Sep 10, 2023
1 parent fb4e70b commit 04aeab7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,10 @@ The features/techniques employed by the skeleton include:
- tox for running tests
- A README.rst as reStructuredText with some popular badges, but with Read the Docs badges commented out
- A CHANGES.rst file intended for publishing release notes about the project
- Use of [Black](https://black.readthedocs.io/en/stable/) for code formatting (disabled on unsupported Python 3.5 and earlier)
- Use of [Black](https://black.readthedocs.io/en/stable/) for consistent style
- Integrated type checking through [mypy](https://github.com/python/mypy/)
- Dependabot enabled to enable supply chain security
- Use of [diff-cover](https://pypi.org/project/diff-cover) to encourage test coverage

## Packaging Conventions

Expand Down Expand Up @@ -144,6 +145,7 @@ Other environments (invoked with `tox -e {name}`) supplied include:

- a `docs` environment to build the documentation
- a `release` environment to publish the package to PyPI
- a `diffcov` environment to check coverage against `main`

A pytest.ini is included to define common options around running tests. In particular:

Expand Down

0 comments on commit 04aeab7

Please sign in to comment.