Nitpick

Command-line tool and flake8 plugin to enforce the same settings across multiple language-independent projects.

Useful if you maintain multiple projects and are tired of copying/pasting the same INI/TOML/YAML/JSON keys and values over and over, in all of them.

The tool now has an “apply” feature that modifies configuration files directly (pretty much like black and isort do with Python files). See Command-line interface for more info.

Many more features are planned for the future, check the roadmap.

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
• Configuration
  • Remote style
  • Cache
    • Expiring after a predefined time
    • Forever
    • Never
    • Clearing
  • Local style
  • Multiple styles
  • Override a remote style
• Examples
  • Absent files
  • black
  • EditorConfig
  • 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
  • tox
• Auto-detection
  • Root dir of the project
  • Main Python file
• 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
  • pyproject.toml
  • .pre-commit-config.yaml
  • INI files
  • JSON files
  • Text files
• Troubleshooting
  • Crash on multi-threading
  • ModuleNotFoundError: No module named ‘nitpick.plugins.XXX’
• 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