The app makes a single comment on the Pull Request and keeps updating it on new commits. This reduces noise in the email.
Easy installation via GitHub app distribution. It starts work instantaneously without the need for any configuration.
The app can be configured for all of the pycodestyle/flake8 settings like max-line-length, ignoring specific errors, etc. There are additional options available for configuration like choosing the linter and scanning only the diff of the Pull Request.
The bot can be asked to suggest a diff of the changes to fix code quality issues.
The bot can be asked to create a Pull Request on the author's branch, so that they can fix all the issues at once just by merging the Pull Request.
The app is used by organizations like Pandas, Scikit Image, Spyder IDE, Scikit Learn Contrib, Astropy, Sunpy, etc. Check out the complete list of organizations and individual users.
What's the difference between this Python project and similar ones?
In other services, style issues get lost in the long build logs and the authors of the Pull Requests are not notified about them. A GitHub comment separates code style issue with the CI build.
Pleasant experience for the contributors as well as maintainers. It does not cause failed checks to obstruct merging. Nor does it make comment after comment for additional commits. It keeps on editing the first comment for update.
By default the bot does not make any comment if no Python files are involved. This means, users can install it on an organization with numerous projects, and the app will function only on the ones which involve Python.
The comment made by the bot is very descriptive with the errors. The line and column numbers are hyperlinked to the files involved in the PR. See an example.
--
Anyone who agrees with this pull request could vote for it by adding a 👍 to it, and usually, the maintainer will merge it when votes reach 20.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/vinta/awesome-python/pull/1256
**Author:** [@OrkoHunter](https://github.com/OrkoHunter)
**Created:** 3/14/2019
**Status:** ✅ Merged
**Merged:** 5/25/2019
**Merged by:** [@vinta](https://github.com/vinta)
**Base:** `master` ← **Head:** `pep8speaks`
---
### 📝 Commits (1)
- [`73ab75a`](https://github.com/vinta/awesome-python/commit/73ab75a37ba08e8b4253b4edf83bee0f40e6c624) Add PEP 8 Speaks
### 📊 Changes
**1 file changed** (+1 additions, -0 deletions)
<details>
<summary>View changed files</summary>
📝 `README.md` (+1 -0)
</details>
### 📄 Description
## What is this Python project?
PEP 8 Speaks is a GitHub app to automatically review Python code style over Pull Requests.
GitHub - https://github.com/OrkoHunter/pep8speaks
Website - https://pep8speaks.com
GitHub Marketplace - https://github.com/marketplace/pep-8-speaks
### Features
- The app makes a single comment on the Pull Request and keeps updating it on new commits. This reduces noise in the email.
- Easy installation via GitHub app distribution. It starts work instantaneously without the need for any configuration.
- The app can be configured for all of the pycodestyle/flake8 settings like max-line-length, ignoring specific errors, etc. There are additional options available for configuration like choosing the linter and scanning only the diff of the Pull Request.
- The bot can be asked to suggest a diff of the changes to fix code quality issues.
- The bot can be asked to create a Pull Request on the author's branch, so that they can fix all the issues at once just by merging the Pull Request.
More miscellaneous features are over [here](https://github.com/OrkoHunter/pep8speaks#main-features).
The app is used by organizations like Pandas, Scikit Image, Spyder IDE, Scikit Learn Contrib, Astropy, Sunpy, etc. Check out [the complete list](https://github.com/OrkoHunter/pep8speaks/wiki/List-of-users-and-orgs) of organizations and individual users.
## What's the difference between this Python project and similar ones?
- In other services, style issues get lost in the long build logs and the authors of the Pull Requests are not notified about them. A GitHub comment separates code style issue with the CI build.
- Pleasant experience for the contributors as well as maintainers. It does not cause failed checks to obstruct merging. Nor does it make comment after comment for additional commits. It keeps on editing the first comment for update.
- By default the bot does not make any comment if no Python files are involved. This means, users can install it on an organization with numerous projects, and the app will function only on the ones which involve Python.
- The comment made by the bot is very descriptive with the errors. The line and column numbers are hyperlinked to the files involved in the PR. See [an example](https://github.com/pandas-dev/pandas/pull/24158).
--
Anyone who agrees with this pull request could vote for it by adding a :+1: to it, and usually, the maintainer will merge it when votes reach **20**.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/vinta/awesome-python/pull/1256
Author: @OrkoHunter
Created: 3/14/2019
Status: ✅ Merged
Merged: 5/25/2019
Merged by: @vinta
Base:
master← Head:pep8speaks📝 Commits (1)
73ab75aAdd PEP 8 Speaks📊 Changes
1 file changed (+1 additions, -0 deletions)
View changed files
📝
README.md(+1 -0)📄 Description
What is this Python project?
PEP 8 Speaks is a GitHub app to automatically review Python code style over Pull Requests.
GitHub - https://github.com/OrkoHunter/pep8speaks
Website - https://pep8speaks.com
GitHub Marketplace - https://github.com/marketplace/pep-8-speaks
Features
More miscellaneous features are over here.
The app is used by organizations like Pandas, Scikit Image, Spyder IDE, Scikit Learn Contrib, Astropy, Sunpy, etc. Check out the complete list of organizations and individual users.
What's the difference between this Python project and similar ones?
--
Anyone who agrees with this pull request could vote for it by adding a 👍 to it, and usually, the maintainer will merge it when votes reach 20.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.