An example package. Generated with cookiecutter-pylibrary.
pip install chinese-verdict-sheet-nlp
To use the project:
import chinese_verdict_sheet_nlp
chinese_verdict_sheet_nlp()To run all the steps, you can execute the "tox" command. This command will perform the following steps:
tox
| clean | remove build artifacts |
|---|---|
| check | check coding style with flake8, isort |
| docs | generate Sphinx HTML documentation, including API docs |
| py38, py39, py310 | run tests with the specified Python version |
| report | generate coverage report with the specified Python version |
You can also execute specific steps individually.
To run tests, execute the following command:
tox -e py38
To run tests and generate coverage report, execute the following command:
tox -e report
A code coverage report will be generated and saved as htmlcov/index.html.
Note, to combine the coverage data from all the tox environments run:
| Windows | set PYTEST_ADDOPTS=--cov-append tox |
|---|---|
| Other | PYTEST_ADDOPTS=--cov-append tox |
To run check coding style, execute the following command:
tox -e check
To run build documentation, execute the following command:
tox -e docs
A documentation will be generated and saved as dist/docs directory.