■ ■ ■ ■ ■ ■
docs/source/development.rst
| skipped 2 lines |
3 | 3 | | Development |
4 | 4 | | ============== |
5 | 5 | | |
| 6 | + | Testing |
| 7 | + | ------- |
| 8 | + | |
| 9 | + | It is recommended use Python 3.7/3.8 for test due to some conflicts in 3.9. |
| 10 | + | |
| 11 | + | Install test requirements: |
| 12 | + | |
| 13 | + | .. code-block:: console |
| 14 | + | |
| 15 | + | pip install -r test-requirements.txt |
| 16 | + | |
| 17 | + | |
| 18 | + | Use the following commands to check Maigret: |
| 19 | + | |
| 20 | + | .. code-block:: console |
| 21 | + | |
| 22 | + | # run linter and typing checks |
| 23 | + | # order of checks% |
| 24 | + | # - critical syntax errors or undefined names |
| 25 | + | # - flake checks |
| 26 | + | # - mypy checks |
| 27 | + | make lint |
| 28 | + | |
| 29 | + | # run testing with coverage html report |
| 30 | + | # current test coverage is 60% |
| 31 | + | make text |
| 32 | + | |
| 33 | + | # open html report |
| 34 | + | open htmlcov/index.html |
| 35 | + | |
| 36 | + | |
6 | 37 | | How to publish new version of Maigret |
7 | 38 | | ------------------------------------- |
8 | 39 | | |
| skipped 62 lines |