Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.08 KB

README-DEV.md

File metadata and controls

57 lines (45 loc) · 1.08 KB

Testing

Use pytest to run the tests in the tests directory:

virtualenv -p /usr/bin/python3 venv
. venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt
pytest

Test running examples

Only unit tests:

pytest -m "not integration"

Only integration tests:

pytest -m integration

All tests:

pytest

All tests with code coverage:

pytest --cov=dinglehopper --cov-report=html

Static code analysis:

pytest -k "not test" --mypy
pytest -k "not test" --ruff

How to use pre-commit

This project optionally uses pre-commit to check commits. To use it:

  • Install pre-commit, e.g. pip install -r requirements-dev.txt
  • Install the repo-local git hooks: pre-commit install

Releasing a new version

  • Update ocrd-tool.json
  • git commit
  • git tag vx.y.z
  • git push && git push --tags
  • The GitHub Actions workflow release will now create a. a new release on GitHub and b. a new release on PyPI
  • Currently requires a review for PYPI?