diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-03-17 15:10:35 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-03-17 15:10:35 -0500 |
| commit | 55cc996368469bf9c3cfec5789d9c9675bd4e664 (patch) | |
| tree | eeb4c02502d79ef0d723b90de3fdef401e007bbe /old/docs/setuptools.rst | |
| parent | 0f2a2614eee2f50f66b097d29206c230092c0b05 (diff) | |
| download | flake8-55cc996368469bf9c3cfec5789d9c9675bd4e664.tar.gz | |
Move old documentation out of the way
Diffstat (limited to 'old/docs/setuptools.rst')
| -rw-r--r-- | old/docs/setuptools.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/old/docs/setuptools.rst b/old/docs/setuptools.rst new file mode 100644 index 0000000..8bc080d --- /dev/null +++ b/old/docs/setuptools.rst @@ -0,0 +1,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" + ] + ) + + |
