==============
 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 :ref:`installation-guide` section for how to install |Flake8|.

.. toctree::
    :maxdepth: 2

    invocation
    configuration
    options
    error-codes
    violations
    using-plugins
    using-hooks
    python-api

.. config files
.. command-line tutorial
.. VCS usage
.. installing and using plugins