Useful if you maintain multiple projects and want to use the same configs in all of them.
A “nitpick code style” is a TOML file with the settings that should be present in config files from other tools.
Example of a style:
["pyproject.toml".tool.black] line-length = 120 ["pyproject.toml".tool.poetry.dev-dependencies] pylint = "*" ["setup.cfg".flake8] ignore = "D107,D202,D203,D401" max-line-length = 120 inline-quotes = "double" ["setup.cfg".isort] line_length = 120 multi_line_output = 3 include_trailing_comma = true force_grid_wrap = 0 combine_as_imports = true
This style will assert that:
- … black, isort and flake8 have a line length of 120;
- … flake8 and isort are configured as above in
- … Pylint is present as a Poetry dev dependency in
To try the package, simply install it (in a virtualenv or globally) and run
flake8 on a project with at least one Python (
# Install using pip: $ pip install -U nitpick # Or using Poetry: $ poetry add --dev nitpick $ flake8 .
Nitpick will download and use the opinionated default style file.
You can use it as a template to configure your own style.
Run as a pre-commit hook (recommended)
If you use pre-commit on your project (you should), add this to the
.pre-commit-config.yaml in your repository:
repos: - repo: https://github.com/andreoliwa/nitpick rev: v0.23.1 hooks: - id: nitpick
To install the
commit-msg Git hooks:
pre-commit install --install-hooks pre-commit install -t commit-msg
To start checking all your code against the default rules:
pre-commit run --all-files
For more details on styles and which configuration files are currently supported, see the full documentation.