Use Poetry to setup environment.
To install poetry, run:
$ pip install poetry
or use pipx (x is 3 or anything of your python version).
Setup poetry environment:
$ poetry install
Then enter the environment:
$ poetry shell
To check codes at the commit, use pre-commit.
pre-commit command will be installed in the poetry environment.
First, run:
$ pre-commit install
Then pre-commit will be run at the commit.
Sometimes, you may want to skip the check. In that case, run:
$ git commit --no-verify
You can run pre-commit on entire repository manually:
$ pre-commit run -a
Tests are written with pytest.
Write tests in /tests directory.
To run tests, run:
$ pytest
The default setting runs tests in parallel with -n auto.
If you run tests in serial, run:
$ pytest -n 0
If you push a repository to GitHub, GitHub Actions will run a test job by GitHub Actions.
The job runs at the Pull Request, too.
It checks codes with pre-commit and runs tests with pytest.
It also makes a test coverage report and uploads it to the coverage branch.
You can see the test status as a badge in the README.
If you want to update dependencies automatically, install Renovate into your repository.