10000 Add PEP 8 Speaks to Services -> Code Quality section by OrkoHunter · Pull Request #1256 · vinta/awesome-python · GitHub
[go: up one dir, main page]
Skip to content

Add PEP 8 Speaks to Services -> Code Quality section #1256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 25, 2019
Merged

Add PEP 8 Speaks to Services -> Code Quality section #1256

merged 1 commit into from
May 25, 2019

Conversation

OrkoHunter
Copy link
Contributor
@OrkoHunter OrkoHunter commented Mar 14, 2019 •
edited
Loading

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.

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.

@OrkoHunter
Copy link
Contributor Author

Hello @vinta ! Can you please have a look at this PR and PEP 8 Speaks? It has crossed 20 upvotes.

@vinta vinta merged commit 0e1820c into vinta:master May 25, 2019
@OrkoHunter OrkoHunter deleted the pep8speaks branch May 25, 2019 09:33
@OrkoHunter
Copy link
Contributor Author
OrkoHunter commented Nov 22, 2019 •
edited
Loading

Sadly @vinta removed this and many other services in a commit called "cleanup".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@OrkoHunter @vinta
0