pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-02 11:56:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated setuptools integration doc

Browse source
This commit is contained in:
mrtheb 2013-02-25 14:09:30 -05:00
parent 1e32cfb890
commit 46315ac5f3
1 changed files with 11 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/setuptools.rst
View file

@ -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