Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wemake-services/wemake-python-styleguide
The strictest and most opinionated python linter ever!
https://github.com/wemake-services/wemake-python-styleguide
code-quality flake8 flake8-plugin hacktoberfest linter python python3 styleguide wemake wemake-services
Last synced: 4 days ago
JSON representation
The strictest and most opinionated python linter ever!
- Host: GitHub
- URL: https://github.com/wemake-services/wemake-python-styleguide
- Owner: wemake-services
- License: mit
- Created: 2018-03-09T21:04:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-06T07:34:42.000Z (7 days ago)
- Last Synced: 2024-12-06T08:26:02.581Z (7 days ago)
- Topics: code-quality, flake8, flake8-plugin, hacktoberfest, linter, python, python3, styleguide, wemake, wemake-services
- Language: Python
- Homepage: https://wemake-python-styleguide.rtfd.io
- Size: 10.3 MB
- Stars: 2,556
- Watchers: 31
- Forks: 378
- Open Issues: 137
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - wemake-python-styleguide - The strictest and most opinionated python linter ever, with optional reviewdog output on the PR
- fucking-awesome-actions - wemake-python-styleguide - The strictest and most opinionated python linter ever, with optional reviewdog output on the PR
- my-awesome-starred - wemake-services/wemake-python-styleguide - The strictest and most opinionated python linter ever! (Python)
- awesome-python-resources - GitHub - 9% open · ⏱️ 16.08.2022): (代码分析和 Lint 工具)
- awesome-for-beginners - wemake-python-styleguide
- awesome-list - wemake-python-styleguide - The strictest and most opinionated python linter ever. (Containers & Language Extentions & Linting / For Python)
- awesome-flake8-extensions - wemake-python-styleguide - The strictest and most opinionated python linter ever. (All-in-one)
- awesome-workflows - wemake-python-styleguide - The strictest and most opinionated python linter ever, with optional reviewdog output on the PR
- best-of-python-dev - GitHub - 10% open · ⏱️ 30.05.2024): (Linters & Style Checkers)
- awesome-linters - wemake-python-styleguide - (Linters / Python)
- awesome-python-typing - wemake-python-styleguide - The strictest and most opinionated Python linter ever. (Tools / Linters)
- fucking-awesome-for-beginners - wemake-python-styleguide
README
# wemake-python-styleguide
[](https://wemake-services.github.io)
[](https://opencollective.com/wemake-python-styleguide)
[](https://github.com/wemake-services/wemake-python-styleguide/actions?query=workflow%3Atest)
[](https://codecov.io/gh/wemake-services/wemake-python-styleguide)
[](https://pypi.org/project/wemake-python-styleguide/)
[](https://github.com/wemake-services/wemake-python-styleguide)
---
Welcome to the strictest and most opinionated Python linter ever.
`wemake-python-styleguide` is actually a [flake8](http://flake8.pycqa.org/en/latest/)
plugin with [some other plugins](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/violations/index.html#external-plugins) as dependencies.
## Quickstart
```bash
pip install wemake-python-styleguide
```
You will also need to create a `setup.cfg` file with the [configuration](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/configuration.html).
[Try it online](https://wps.orsinium.dev)!
We highly recommend to also use:
- [ondivi](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/ondivi.html) for easy integration into a **legacy** codebase
- [nitpick](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/nitpick.html) for sharing and validating configuration across multiple projects
## Running
```bash
flake8 your_module.py
```
This app is still just good old `flake8`!
And it won't change your existing workflow.
See ["Usage" section](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/setup.html)
in the docs for examples and integrations.
We also support [GitHub Actions](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/github-actions.html) as first class-citizens.
[Try it out](https://github.com/marketplace/actions/wemake-python-styleguide)!
## Strict is the new cool
Strict linting offers the following benefits to developers and companies:
1. Ensures consistency - no matter who works on it, the end product will always be the same dependable code
2. Helps avoid potential bugs - strict rules make sure that you don't make common mistakes
3. Efficient code reviews - each piece of code has a similar familiar style and syntax. If it passes all the checks, there's little left to review!
4. Fewer code revisions - strict linting ensures that you don't have to re-write the codebase again and again
5. Reduce code redundancy - Sometimes we write complex code as we are thinking in a certain way about a problem. The linter offers suggestions that can help simplify the code and eliminate redundant statements
## What we are about
The ultimate goal of this project is
to make all people write **exactly** the same `Python` code.
| | flake8 | pylint | black | mypy | ruff | wemake-python-styleguide |
|----------------------------|--------|--------|-------|------|------|--------------------------|
| Formats code? | ❌ | ❌ | ✅ | ❌ | ✅ | ❌ |
| Finds style issues? | 🤔 | ✅ | 🤔 | ❌ | ✅ | ✅ |
| Finds bugs? | 🤔 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Finds complex code? | ❌ | 🤔 | ❌ | ❌ | ✅ | ✅ |
| Has a lot of strict rules? | ❌ | 🤔 | ❌ | ❌ | ✅ | ✅ |
| Has a lot of plugins? | ✅ | ❌ | ❌ | 🤔 | ❌ | ✅ |
We have several primary objectives:
1. Significantly reduce the complexity of your code and make it more maintainable
2. Enforce "There should be one -- and preferably only one -- obvious way to do it" rule to coding and naming styles
3. Protect developers from possible errors and enforce best practices
You can find all error codes and plugins [in the docs](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/violations/index.html).
## What we are not
We are *not* planning to do the following things:
0. Assume or check types, use `mypy` together with our linter
1. [Reformat code](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/auto-formatters.html), since we believe that developers should do that
2. Check for `SyntaxError` or logical bugs, write tests instead
3. Appeal to everyone. But, you can [switch off](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/setup.html#ignoring-violations) any rules that you don't like
## Supporting us :tada:
We in [wemake.services](https://wemake.services) make
all our tools open-source by default, so the community can benefit from them.
If you use our tools and they make your life easier and brings business value,
you can return us a favor by supporting the work we do.
[](https://opencollective.com/wemake-python-styleguide)
[](https://opencollective.com/wemake-python-styleguide)
[](https://opencollective.com/wemake-python-styleguide)
## Show your style :sunglasses:
If you use our linter - it means that your code is awesome.
You can be proud of it!
And you should share your accomplishment with others
by including a badge in your `README` file. It looks like this:
[](https://github.com/wemake-services/wemake-python-styleguide)
### Markdown
```md
[](https://github.com/wemake-services/wemake-python-styleguide)
```
### Restructured text
```rst
.. image:: https://img.shields.io/badge/style-wemake-000000.svg
:target: https://github.com/wemake-services/wemake-python-styleguide
```
## Contributing
We **warmly welcome** all contributions!
[](https://github.com/wemake-services/wemake-python-styleguide/graphs/contributors)
See ["Contributing"](https://wemake-python-styleguide.rtfd.io/en/latest/pages/api/index.html#contributing) section in the documentation if you want to contribute.
You can start with [issues that need some help](https://github.com/wemake-services/wemake-python-styleguide/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
right now.