docs/setuptools.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

Setuptools integration
======================

Upon installation, Flake8 enables a setuptools command that checks Python 
files declared by your project. 

Running ``python setup.py flake8`` on the command line will check the files 
listed in your ``py_modules`` and ``packages``.  If any warning is found, 
the command will exit with an error code::

    $ python setup.py flake8

Also, to allow users to be able to use the command without having to install 
flake8 themselves, add flake8 to the setup_requires of your setup() like so::

    setup(
        name="project",
        packages=["project"],

        setup_requires=[
            "flake8"
        ]
    )