FlakeHeaven

It’s a Flake8 wrapper to make it cool.

• Lint md, rst, ipynb, and more.

• Shareable and remote configs.

• Legacy-friendly: ability to get report only about new errors.

• Caching for much better performance.

• Use only specified plugins, not everything installed.

• Make output beautiful.

• pyproject.toml support.

• Check that all required plugins are installed.

• Syntax highlighting in messages and code snippets.

• PyLint integration.

• Powerful GitLab support.

• Codes management:

  • Manage codes per plugin.

  • Enable and disable plugins and codes by wildcard.

  • Show codes for installed plugins.

  • Show all messages and codes for a plugin.

  • Allow codes intersection for different plugins.

Compatibility

FlakeHeaven supports all flake8 plugins, formatters, and configs. However, FlakeHeaven has its own beautiful way to configure enabled plugins and codes. So, options like --ignore and --select are disabled. You can have flake8 and FlakeHeaven in one project if you want but enabled plugins should be explicitly specified.

Main Info

• Config
• Formatters
• Plugins
• Parsers
• IDE integration
• Troubleshooting

Commands

• lint: run flake8
• baseline: integrate into a huge project
• plugins: installed plugins, codes, rules
• codes: messages from plugin
• code: find the given code
• missed: rules without matching plugins
• config: show configuration

• API Documentation
  • flakeheaven package
    • Subpackages
    • Submodules