diff options
| author | mrtheb <devnull@localhost> | 2013-02-25 14:09:30 -0500 |
|---|---|---|
| committer | mrtheb <devnull@localhost> | 2013-02-25 14:09:30 -0500 |
| commit | 46315ac5f352c90da770acba611b7174826af66f (patch) | |
| tree | 9cd99cf6ad87a49080da8d0add2a35e6da6d0ca6 /docs | |
| parent | 1e32cfb8904d76ebeb0c5d17354c47efc369639a (diff) | |
| download | flake8-46315ac5f352c90da770acba611b7174826af66f.tar.gz | |
Updated setuptools integration doc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/setuptools.rst | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/setuptools.rst b/docs/setuptools.rst index d993bdf..8bc080d 100644 --- a/docs/setuptools.rst +++ b/docs/setuptools.rst @@ -1,9 +1,17 @@ Setuptools integration ====================== -Flake8 now depends on setuptools and its installation enables a command -that checks the Python files declared by your project. To use it, add -flake8 to your setup_requires:: +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", @@ -14,8 +22,4 @@ flake8 to your setup_requires:: ] ) -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 |
