PEP8 Speaks

because it matters.

A GitHub integration which checks pep8 issues and then comments over Pull Requests

How to Use?

• Go to the homepage of the Integration
• Click on Install button
• Add the repositories you want this service for

Features

• To pause the bot from commenting on a PR, comment @pep8speaks Keep Quiet.
• Comment @pep8speaks Resume now. to resume.
• The keywords are quiet and resume and the mention of the bot.
• The bot's last comment is not repeated. Hence if the PR is updated and the bot does not comment, it means it stands with its previous comment.

Configuration

The integration can be configured additionally by adding a .pep8speaks.yml file to the base directory of the repo. Here are the available options of the config file :

# File : .pep8speaks.yml

message:  # Customize the comment made by the bot
    opened:  # Messages when a new PR is submitted
        header: "Hello @{name}, Thank you for submitting the Pull Request !"
                # The keyword {name} is converted into the author's username
        footer: "Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r)"
                # The messages can be written as they would over GitHub
    updated:  # Messages when new commits are added to the PR
        header: "Hello @{name}, Thank you for updating !"
        footer: ""  # Why to comment the link to the style guide everytime? :)

ignore:  # Errors and warnings to ignore
    - W391  # This comes up if there's a blank line at end of file
    - E203  # You shouldn't be ignoring this. It's for whitespaces before ':'

scanner:
    diff_only: False  # If True, errors caused by only the patch are shown

The config file is not required for it to work. The default settings are shown above in the image.

How to fix?

• Check the errors locally by the command line tool pycodestyle (previously known as pep8).
• autopep8 is another command line tool to fix the issues.

Media

• Product Hunt

Contribute

This is a very young project. If you have got any suggestions for new features or improvements, please comment over here. Pull Requests are most welcome !

❤️