Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Transforms pep8 or flake8 output into an HTML report.

Project description

Pepper8 Version Requirements Status

Transform pep8 or flake8 output to HTML

To install pepper8, simply use pip.

pip install pepper8

Or you can clone the latest master branch and build using setuptools

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

pepper8 -o report.html <filename>

or you can pipe output from another file or process

cat flake8.out | pepper8 > report.html

If no output file is specified with -o, the HTML report is written to stdout, allowing output redirection or piping

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

Pepper8 PEP 8 HTML Report

TeamCity custom chart data using custom buildStatistics messages if run under TeamCity

Custom TeamCity Flake8/PEP8 Warning/Error build metrics

Changelog

1.1.0

Expand pepper8 to account for all possible alphanumeric violation codes on a [A-Z][0-9]{3,4} format. Updated broken link to flake8-readthedocs.

1.0.4

Fixed a Python 2 and 3 compatibility issue. Added changelog to README.

1.0.3

Fixed a bug causing missed statistics for last file. Split the title summary stats into the Flake8 plugins.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pepper8, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size pepper8-1.1.1-py2.py3-none-any.whl (11.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pepper8-1.1.1.tar.gz (8.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page