Metadata-Version: 2.1
Name: flakehell
Version: 0.1.3
Summary: Flake8 wrapper to make it nice and configurable
Home-Page: https://gitlab.com/life4/flakehell
Project-URL: Documentation, https://flakehell.readthedocs.io/
Author: Gram (@orsinium)
Author-email: master_fess@mail.ru
Requires-Python: >=3.5
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Provides-Extra: dev


FlakeHell
=========

It's a `Flake8 <https://gitlab.com/pycqa/flake8>`_ wrapper to make it cool.


* Sharable and remote configs.
* Legacy-friendly: ability to get report only about new errors.
* Use only specified plugins, not everything installed.
* Manage codes per plugin.
* Enable and disable plugins and codes by wildcard.
* Make output beautiful.
* ``pyproject.toml`` support.
* Show codes for installed plugins.
* Show all messages and codes for a plugin.
* Check that all required plugins are installed.
* Syntax highlighting in messages and code snippets.


.. image:: ./assets/grouped.png
   :target: ./assets/grouped.png
   :alt: output example


Installation
------------

.. code-block:: bash

   python3 -m pip install --user flakehell

Usage
-----

First of all, let's create ``pyproject.toml`` config:

.. code-block::

   [tool.flakehell]
   # optionally inherit from remote config (or local if you want)
   base = "https://gitlab.com/life4/flakehell/raw/master/pyproject.toml"
   # specify any flake8 options. For example, exclude "example.py":
   exclude = ["example.py"]
   # make output nice
   format = "grouped"
   # 80 chars aren't enough in 21 century
   max_line_length = 90
   # show line of source code in output
   show_source = true

   # list of plugins and rules for them
   [tool.flakehell.plugins]
   # include everything in pyflakes except F401
   pyflakes = ["+*", "-F401"]
   # enable only codes from S100 to S199
   flake8-bandit = ["-*", "+S1**"]
   # enable everything that starts from `flake8-`
   "flake8-*" = ["+*"]
   # explicitly disable plugin
   flake8-docstrings = ["-*"]


* You can specify any flake8 settings in ``[tool.flakehell]``.

Show plugins that aren't installed yet:

.. code-block:: bash

   flakehell missed

Show installed plugins, used plugins, specified rules, codes prefixes:

.. code-block:: bash

   flakehell plugins


.. image:: ./assets/plugins.png
   :target: ./assets/plugins.png
   :alt: plugins command output


Show codes and messages for a specific plugin:

.. code-block:: bash

   flakehell codes pyflakes


.. image:: ./assets/codes.png
   :target: ./assets/codes.png
   :alt: codes command output


Run flake8 against the code:

.. code-block:: bash

   flakehell lint

This command accepts all the same arguments as Flake8.

Formatters
----------

Formatters make errors output nice. Available formatters:


* ``colored`` -- for humans.
* ``grouped`` -- also colored, but all messages are explicitly grouped by file.
* ``json`` -- no colors, only one json-dict per line for every error.

Also, you can specify ``show_source = true`` in the config to show line of source code where error occurred with syntax highlighting.

Colored:


.. image:: ./assets/colored.png
   :target: ./assets/colored.png
   :alt: colored


Colored with source code:


.. image:: ./assets/colored-source.png
   :target: ./assets/colored-source.png
   :alt: colored


Grouped:


.. image:: ./assets/grouped.png
   :target: ./assets/grouped.png
   :alt: grouped


Grouped with source code:


.. image:: ./assets/grouped-source.png
   :target: ./assets/grouped-source.png
   :alt: grouped


JSON:


.. image:: ./assets/json.png
   :target: ./assets/json.png
   :alt: json


Integrating into a huge codebase
--------------------------------

First of all, let's create baseline.

.. code-block:: bash

   flakehell baseline > baseline.txt

Then specify path to the baseline file:

.. code-block::

   [tool.flakehell]
   baseline = "baseline.txt"

Now, ``flakehell lint`` command will ignore all your current errors. It will report only about new errors, all errors in a new code, or if old line of code was modified.
