PEP 8 Speaks is a GitHub integration which detects Python code style issues on new Pull Requests. You can install it on your Python projects and configure with your own code style. Check out the project on GitHub.

Quick links

• Website: https://pep8speaks.com
• GitHub: https://github.com/OrkoHunter/pep8speaks

About the project

Maintainers of Python projects have a difficult time reviewing Pull Requests by new contributors who may not be aware of the code style. Due to code style issues hidden in CI logs, they are often overlooked when accepting new contributions. This project makes reviewing Pull Requests a little bit easier by reviewing the Pull Request for code style issues.

Code Style is important. It improves readability, prevents potential bugs (code smells) and lowers the barrier for new contributors a little bit. The project is designed to be helpful to the maintainers of Python projects which receive code contributions.

PEP 8 Speaks was launched in early 2017. The project is constantly under development with additions and modifications of features. Users report back with suggestions and "feature requests" which helps in shaping the future of the project. Check out the list of open issues on GitHub to understand where this project is headed and the list of closed issues and Pull Requests to see how it has evolved.

Use of funds

Read the call for funding at - https://github.com/OrkoHunter/pep8speaks/wiki/Funding

PEP 8 Speaks is a free and open source software. A fork of the software can be modified and hosted by anyone without the need of paying or contributing back to the project.

However, the GitHub app needs a host server to process the requests. Heroku (current provider) allows a certain number of free hosting hours. However, with the increasing number of users and webhook payloads to the server, this would not be possible. As of February 2019, PEP 8 Speaks needs a paid Heroku host (dyno) for the last two days of the month, due to the exhaustion of free hours.

Additional funds allow the use of developer tools (logging services, etc.) on the server to aid the debugging process, which is very time-consuming as of now. Future plans include supporting Gitlab and Bitbucket platforms as well, which would significantly include server load and make it extremely difficult to run on free heroku accounts.

Minimum funds required for hosting this project is $7 per month.

Sponsorship Tiers

1. Backer

All dollars matter. Contribute $2 or more and get your Name and Link to your site in the Project README and the project website.

2. Silver Sponsor

$5 per month. You will get your Logo, Name, and Link to your site in the Project README and the project website.

3. Gold Sponsor

$84 per year. This will cover all the hosting costs for one year. You will get your Logo, Name, and Link to your site in the Project README and the project website. Your info will be added in @pep8speaks's GitHub bio.