Metadata-Version: 1.1
Name: pytest-flake8
Version: 1.0.5
Summary: pytest plugin to check FLAKE8 requirements
Home-page: https://github.com/tholo/pytest-flake8
Author: Thorsten Lockert
Author-email: tholo@sigmasoft.com
License: BSD License
Description: pytest plugin for efficiently checking PEP8 compliance 
        ======================================================
        
        .. image:: https://img.shields.io/pypi/v/pytest-flake8.svg
            :target: https://pypi.python.org/pypi/pytest-flake8
        
        .. image:: https://img.shields.io/pypi/pyversions/pytest-flake8.svg
            :target: https://pypi.python.org/pypi/pytest-flake8
        
        .. image:: https://img.shields.io/pypi/implementation/pytest-flake8.svg
            :target: https://pypi.python.org/pypi/pytest-flake8
        
        .. image:: https://img.shields.io/pypi/status/pytest-flake8.svg
            :target: https://pypi.python.org/pypi/pytest-flake8
        
        .. image:: https://travis-ci.org/tholo/pytest-flake8.svg?branch=master
            :target: https://travis-ci.org/tholo/pytest-flake8
        
        .. image:: https://img.shields.io/github/issues/tholo/pytest-flake8.svg
            :target: https://github.com/tholo/pytest-flake8/issues
        
        .. image:: https://img.shields.io/github/issues-pr/tholo/pytest-flake8.svg
            :target: https://github.com/tholo/pytest-flake8/pulls
        
        Usage
        -----
        
        Install by running the command::
        
            pip install pytest-flake8
        
        After installing it, when you run tests with the option::
        
            pytest --flake8
        
        every file ending in ``.py`` will be discovered and checked with
        flake8.
        
        .. note::
        
            If optional flake8 plugins are installed, those will
            be used automatically. No provisions have been made for
            configuring these via `pytest`_.
        
        .. warning::
        
            Running flake8 tests on your project is likely to cause a number 
            of issues. The plugin allows one to configure on a per-project and
            per-file basis which errors or warnings to ignore, see
            flake8-ignore_.
        
        .. _flake8-ignore:
        
        Configuring FLAKE8 options per project and file
        -----------------------------------------------
        
        Maximum line length can be configured for the whole project
        by adding a ``flake8-max-line-length`` option to your ``setup.cfg``
        or ``tox.ini`` file like this::
        
            # content of setup.cfg
            [pytest]
            flake8-max-line-length = 99
        
        Note that the default will be what naturally comes with `flake8`_
        (which it turn gets its default from `pycodestyle`_).
        
        You may configure flake8-checking options for your project
        by adding an ``flake8-ignore`` entry to your ``setup.cfg``
        or ``tox.ini`` file like this::
        
            # content of setup.cfg
            [pytest]
            flake8-ignore = E201 E231
        
        This would globally prevent complaints about two whitespace issues.
        Rerunning with the above example will now look better::
        
            $ pytest -q  --flake8
            collecting ... collected 1 items
            .
            1 passed in 0.01 seconds
        
        If you have some files where you want to specifically ignore 
        some errors or warnings you can start a flake8-ignore line with 
        a glob-pattern and a space-separated list of codes::
        
            # content of setup.cfg
            [pytest]
            flake8-ignore = 
                *.py E201
                doc/conf.py ALL
        
        So if you have a conf.py like this::
        
            # content of doc/conf.py
        
            func (  [1,2,3]) #this line lots PEP8 errors :)
        
        then running again with the previous example will show a single
        failure and it will ignore doc/conf.py alltogether::
        
            $ pytest --flake8 -v # verbose shows what is ignored
            ======================================= test session starts ========================================
            platform darwin -- Python 2.7.6 -- py-1.4.26 -- pytest-2.7.0 -- /Users/tholo/Source/pytest/bin/python
            cachedir: /Users/tholo/Source/pytest/src/verify/.cache
            rootdir: /Users/tholo/Source/angular/src/verify, inifile: setup.cfg
            plugins: flake8, cache
            collected 1 items
        
            myfile.py PASSED
        
            ========================================= 1 passed in 0.00 seconds =========================================
        
        Note that doc/conf.py was not considered or imported.
        
        Notes
        -----
        
        The repository of this plugin is at https://github.com/tholo/pytest-flake8
        
        For more info on `pytest`_ see http://pytest.org
        
        The code is partially based on Ronny Pfannschmidt's `pytest-codecheckers`_ plugin.
        
        .. _`pytest`: http://pytest.org
        .. _`flake8`: https://pypi.python.org/pypi/flake8
        .. _`pycodestyle`: https://pypi.python.org/pypi/pycodestyle
        .. _`pytest-codecheckers`: https://pypi.python.org/pypi/pytest-codecheckers
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
