Nitpick

Flake8 plugin to enforce the same tool configuration (flake8, isort, mypy, Pylint…) across multiple Python projects.

Useful if you maintain multiple projects and want to use the same configs in all of them.

Note

This project is still a work in progress, so the API is not fully defined:

• The style file syntax might have changes before the 1.0 stable release;

• The numbers in the NIP* error codes might change; don’t fully rely on them;

• See also Breaking style changes.

Contents:

• Quickstart
  • Install / Basic usage
  • Run as a pre-commit hook (recommended)
  • Apply changes to files
• Styles
  • The style file
  • Configure your own style
  • Default search order for a style
  • Style file syntax
  • Breaking style changes
    • missing_message key was removed
• Auto-detection
  • Root dir of the project
  • Main Python file
• The [tool.nitpick] section
  • Remote style
  • Local style
  • Multiple styles
  • Override a remote style
• The [nitpick] section
  • Minimum version
  • [nitpick.files]
    • Files that should exist
    • Files that should be deleted
    • Comma separated values
  • [nitpick.styles]
• Command-line interface
  • Main options
  • run: Apply style to files
  • ls: List configures files
• Plugins
  • setup.cfg
  • pyproject.toml
  • .pre-commit-config.yaml
  • JSON files
  • Text files
• Defaults
  • Absent files
  • black
  • flake8
  • IPython
  • isort
  • mypy
  • package.json
  • Poetry
  • Bash
  • commitlint
  • pre-commit (hooks)
  • pre-commit (main)
  • pre-commit (Python hooks)
  • Pylint
  • Python 3.6
  • Python 3.7
  • Python 3.8
  • Python 3.9
• Troubleshooting
  • Crash on multi-threading
• Contributing
  • Bug reports or feature requests
  • Documentation improvements
  • Development
    • Pull Request Guidelines
• Authors

API Reference:

• nitpick

Indices and tables

• Index

• Module Index

• Search Page

To Do List