Metadata-Version: 1.1
Name: pepper8
Version: 1.0.2
Summary: Transforms pep8 or flake8 output into an HTML report.
Home-page: https://github.com/myth/pepper8
Author: Aleksander 'myth' Skraastad'
Author-email: myth@overflow.no
License: MIT License
Description: pepper8
        =======
        
        Transform pep8 or flake8 output to HTML
        ---------------------------------------
        
        To install pepper8, simply use pip.
        
        .. code:: bash
        
            pip install pepper8
        
        
        Or you can clone the latest master branch and build using setuptools
        
        .. code:: bash
        
            git clone git@github.com:myth/pepper8.git && cd pepper8 && python setup.py install
        
        
        Usage
        -----
        
        pepper8 operates in two different input modes and two different output modes.
        To read pep8 / flake8 status reports from file use
        
        .. code:: bash
        
            pepper8 -o report.html <filename>
        
        
        If no output file is specified with ``-o``, the HTML report is written to stdout, allowing
        output redirection or piping
        
        .. code:: bash
        
            pepper8 <filename> | less
        
        
        Build statistics
        ----------------
        
        When pepper8 is run using an output file ``-o <filename>``, it will check its run environment
        and print out available build statistics to stdout.
        
        Currently, only TeamCity build statistics are supported with keys ``pepper8warnings`` and ``pepper8errors``.
        
        If you wish to enable full parsing of all PEP 8 / Flake8 errors as failures in TeamCity,
        there already exists a package called `TeamCity-messages <https://github.com/JetBrains/teamcity-messages>`_
        which will be treated as build errors in TeamCity.
        
        The TeamCity build statistics provided by pepper8 is only intended to provide statistical data for use in
        custom build report graphs in addition to the HTML report.
        
        Screenshots from TeamCity integration
        -------------------------------------
        Pepper8 PEP 8 HTML Report
        
        
        .. image:: https://cloud.githubusercontent.com/assets/2415878/10596725/7a2d17a6-76e7-11e5-8630-3e8bd4803a30.png
            :alt: Pepper8 PEP 8 HTML Report
            :align: center
        
        
        
        
        TeamCity custom chart data using custom buildStatistics messages if run under TeamCity
        
        
        
        
        .. image:: https://cloud.githubusercontent.com/assets/2415878/10596726/7a2f43aa-76e7-11e5-8833-429197b45025.png
            :alt: Custom TeamCity Flake8/PEP8 Warning/Error build metrics
            :align: center
            
            
         =========
        Changelog
        =========
        
        1.0.2
        -----
        Changed links in HTML report to default to new window.
        This prevents TeamCity to display blank page due to
        loading of "unsafe scripts" inside the iframe.
        
        
        1.0.1
        -----
        A few bugfixes
        
        
        1.0.0
        -----
        
        Initial release
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
