Using Flake8

Flake8 can be used in many ways. A few:

• invoked on the command-line
• invoked via Python
• called by Git or Mercurial on or around committing

This guide will cover all of these and the nuances for using Flake8.

Note

This portion of Flake8’s documentation does not cover installation. See the Installation section for how to install Flake8.

• Invoking Flake8
• Configuring Flake8
  • Configuration Locations
• Full Listing of Options and Their Descriptions
  • Index of Options
  • Options and their Descriptions
• Error / Violation Codes
• Selecting and Ignoring Violations
  • Ignoring Violations with Flake8
  • Selecting Violations with Flake8
  • Selecting and Ignoring Simultaneously For Fun and Profit
• Using Plugins For Fun and Profit
• Using Version Control Hooks
  • Usage with the pre-commit git hooks framework
  • Built-in Hook Integration
  • Preventing Commits
  • Checking All Modified Files Currently Tracked
• Public Python API
  • Legacy API