pre-commit hooks for python projects.
.pre-commit-hooks.yaml provides pre-defined ids which you just need to add these ids to your .pre-commit-config.yaml.
By installing pyproject-pre-commit package, all necessary tools are installed as dependencies.
If your project uses poetry, do:
$ poetry add --group dev pyproject-pre-commit
Otherwise, install the package in your working environment.
If you use pip, do:
$ pip install pyproject-pre-commit
This will install tools for pre-commit hooks in your working environment, so that you can use these tools, such as black, directly.
If you want to use ruff, you can install pyproject-pre-commit with ruff option.
$ poetry add --group dev "pyproject-pre-commit[ruff]"
$ pip install pyproject-pre-commit[ruff]
Add https://github.com/rcmdnk/pyproject-pre-commit to your .pre-commit-config.yaml, like:
repos:
- repo: https://github.com/rcmdnk/pyproject-pre-commit
rev: v0.3.0
hooks:
- id: black-diff
- id: black
- id: blacken-docs
- id: autoflake-diff
- id: autoflake
- id: autopep8-diff
- id: autopep8
- id: isort-diff
- id: isort
- id: flake8
- id: bandit
- id: mypy
- id: shellcheck
- id: mdformat-check
- id: mdformat
By using pyproject-pre-commit, you can simplify your .pre-commit-config.yaml that you need only repo of https://github.com/rcmdnk/pyproject-pre-commit.
These hooks uses local installation of tools, so pre-commit will use tools installed in your working environment.
This can be made by ppc
command:
$ ppc --pre-commit > .pre-commit-config.yaml
[!NOTE] If you are using poetry, run
poetry run ppc ...
or run afterpoetry shell
.
If you already have it, add hooks w/o repos:
by
$ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
You may want to modify after adding these configurations.
To use ruff
instead of such as black
, flake8
, isort
, add following hooks:
repos:
- repo: https://github.com/rcmdnk/pyproject-pre-commit
rev: v0.3.0
hooks:
- id: ruff-lint-diff
- id: ruff-lint
- id: ruff-format-diff
- id: ruff-format
- id: mypy
- id: shellcheck
- id: mdformat-check
- id: mdformat
This can be made by ppc
command:
$ ppc --pre-commit --ruff > .pre-commit-config.yaml
pre-commit
command is installed as dependencies of pyproject-pre-commit package.
After installing pyproject-pre-commit package, you can run pre-commit
command.
First, install pre-commit hooks by:
$ pre-commit install
then you can run pre-commit by:
$ pre-commit run --all-files
[!NOTE] If you are using poetry, run
poetry run pre-commit ...
or run afterpoetry shell
.
You can find ids in .pre-commit-hooks.yaml.
There are ids for following tools:
black
on python code blocks in documentation files.flake8
is a command-line utility for enforcing style consistency across Python projects.All tools are installed as dependencies of pyproject-pre-commit package.
shellcheck and mdformat are given in addition to python tools as they can be managed by pip and most projects have README.md and some have shell scripts.
For tools which can format files, there are additional ids with -diff
or --check
which show the results before modifying files.
You can see the differences after formatting if you place these ids before ids w/o --diff
or --check
.
You can set options in pyproject.toml for all tools above.
For flake8, flake8-pyproject allows to read options from pyproject.toml
About bandit, there is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give -c pyproject.toml
option in the hooks.
You can set options in pyproject.toml for all tools.
Example options can be made by ppc
command:
$ ppc --pyproject >> pyproject.toml
or
$ ppc --pyproject --ruff >> pyproject.toml
You may want to modify after adding these configurations.