# wemake-python-styleguide
[](https://wemake-services.github.io)
[](https://opencollective.com/wemake-python-styleguide)
[](https://github.com/wemake-services/wemake-python-styleguide/actions/workflows/test.yml)
[](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.
<p align="center">
<a href="https://wemake-python-styleguide.rtfd.io">
<img src="https://raw.githubusercontent.com/wemake-services/wemake-python-styleguide/master/docs/_static/logo.png"
alt="wemake-python-styleguide logo">
</a>
</p>
`wemake-python-styleguide` is actually a [flake8](http://flake8.pycqa.org/en/latest/)
plugin, the only one you will need as your [ruff](https://github.com/astral-sh/ruff) companion.
Fully compatible with **ALL** rules and format conventions from `ruff`.
## 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
## Running
```bash
flake8 your_module.py --select=WPS
```
This app is still just good old `flake8`!
And it won't change your existing workflow.
<p align="center">
<img src="https://raw.githubusercontent.com/wemake-services/wemake-python-styleguide/master/docs/_static/running.png"
alt="invocation results">
</p>
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)!
Can (and should!) be used with `ruff`:
```bash
ruff check && ruff format
flake8 . --select=WPS
```
See example `ruff` configuration in our [`pyproject.toml`](https://github.com/wemake-services/wemake-python-styleguide/blob/master/pyproject.toml#L103).
## 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. Format code or produce stylistic errors, use `ruff format` for 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://github.com/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.
Raw data
{
"_id": null,
"home_page": "https://wemake-python-styleguide.rtfd.io",
"name": "wemake-python-styleguide",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "flake8, flake8-plugin, flake8-formatter, linter, wemake.services, styleguide, code quality, pycqa",
"author": "Nikita Sobolev",
"author_email": "mail@sobolevn.me",
"download_url": "https://files.pythonhosted.org/packages/de/59/489140f56e1d21c1785066f06ec19b539f5bd8f1d572983b9fdc1071979f/wemake_python_styleguide-1.3.0.tar.gz",
"platform": null,
"description": "# wemake-python-styleguide\n\n[](https://wemake-services.github.io)\n[](https://opencollective.com/wemake-python-styleguide)\n[](https://github.com/wemake-services/wemake-python-styleguide/actions/workflows/test.yml)\n[](https://codecov.io/gh/wemake-services/wemake-python-styleguide)\n[](https://pypi.org/project/wemake-python-styleguide/)\n[](https://github.com/wemake-services/wemake-python-styleguide)\n\n---\n\nWelcome to the strictest and most opinionated Python linter ever.\n\n<p align=\"center\">\n <a href=\"https://wemake-python-styleguide.rtfd.io\">\n <img src=\"https://raw.githubusercontent.com/wemake-services/wemake-python-styleguide/master/docs/_static/logo.png\"\n alt=\"wemake-python-styleguide logo\">\n </a>\n</p>\n\n`wemake-python-styleguide` is actually a [flake8](http://flake8.pycqa.org/en/latest/)\nplugin, the only one you will need as your [ruff](https://github.com/astral-sh/ruff) companion.\n\nFully compatible with **ALL** rules and format conventions from `ruff`.\n\n## Quickstart\n\n```bash\npip install wemake-python-styleguide\n```\n\nYou will also need to create a `setup.cfg` file with the [configuration](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/configuration.html).\n\n[Try it online](https://wps.orsinium.dev)!\n\nWe highly recommend to also use:\n\n- [ondivi](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/ondivi.html) for easy integration into a **legacy** codebase\n\n\n## Running\n\n```bash\nflake8 your_module.py --select=WPS\n```\n\nThis app is still just good old `flake8`!\nAnd it won't change your existing workflow.\n\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/wemake-services/wemake-python-styleguide/master/docs/_static/running.png\"\n alt=\"invocation results\">\n</p>\n\nSee [\"Usage\" section](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/setup.html)\nin the docs for examples and integrations.\n\nWe also support [GitHub Actions](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/github-actions.html) as first class-citizens.\n[Try it out](https://github.com/marketplace/actions/wemake-python-styleguide)!\n\nCan (and should!) be used with `ruff`:\n\n```bash\nruff check && ruff format\nflake8 . --select=WPS\n```\n\nSee example `ruff` configuration in our [`pyproject.toml`](https://github.com/wemake-services/wemake-python-styleguide/blob/master/pyproject.toml#L103).\n\n\n## Strict is the new cool\n\nStrict linting offers the following benefits to developers and companies:\n1. Ensures consistency - no matter who works on it, the end product will always be the same dependable code\n2. Helps avoid potential bugs - strict rules make sure that you don't make common mistakes\n3. 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!\n4. Fewer code revisions - strict linting ensures that you don't have to re-write the codebase again and again\n5. 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\n\n\n## What we are about\n\nThe ultimate goal of this project is\nto make all people write **exactly** the same `Python` code.\n\n| | flake8 | pylint | black | mypy | ruff | wemake-python-styleguide |\n|----------------------------|--------|--------|-------|------|------|--------------------------|\n| Formats code? | \u274c | \u274c | \u2705 | \u274c | \u2705 | \u274c |\n| Finds style issues? | \ud83e\udd14 | \u2705 | \ud83e\udd14 | \u274c | \u2705 | \u274c |\n| Finds bugs? | \ud83e\udd14 | \u2705 | \u274c | \u2705 | \u2705 | \u2705 |\n| Finds complex code? | \u274c | \ud83e\udd14 | \u274c | \u274c | \u2705 | \u2705 |\n| Has a lot of strict rules? | \u274c | \ud83e\udd14 | \u274c | \u274c | \u2705 | \u2705 |\n| Has a lot of plugins? | \u2705 | \u274c | \u274c | \ud83e\udd14 | \ud83e\udd14 | \u2705 |\n\nWe have several primary objectives:\n\n1. Significantly reduce the complexity of your code and make it more maintainable\n2. Enforce \"There should be one -- and preferably only one -- obvious way to do it\" rule to coding and naming styles\n3. Protect developers from possible errors and enforce best practices\n\nYou can find all error codes and plugins [in the docs](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/violations/index.html).\n\n\n## What we are not\n\nWe are *not* planning to do the following things:\n\n0. Assume or check types, use `mypy` together with our linter\n1. Format code or produce stylistic errors, use `ruff format` for that\n2. Check for `SyntaxError` or logical bugs, write tests instead\n3. 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\n\n\n## Supporting us :tada:\n\nWe in [wemake.services](https://github.com/wemake-services) make\nall our tools open-source by default, so the community can benefit from them.\nIf you use our tools and they make your life easier and brings business value,\nyou can return us a favor by supporting the work we do.\n\n[](https://opencollective.com/wemake-python-styleguide)\n\n[](https://opencollective.com/wemake-python-styleguide)\n\n[](https://opencollective.com/wemake-python-styleguide)\n\n\n## Show your style :sunglasses:\n\nIf you use our linter - it means that your code is awesome.\nYou can be proud of it!\nAnd you should share your accomplishment with others\nby including a badge in your `README` file. It looks like this:\n\n[](https://github.com/wemake-services/wemake-python-styleguide)\n\n### Markdown\n\n```md\n[](https://github.com/wemake-services/wemake-python-styleguide)\n```\n\n### Restructured text\n\n```rst\n.. image:: https://img.shields.io/badge/style-wemake-000000.svg\n :target: https://github.com/wemake-services/wemake-python-styleguide\n```\n\n\n## Contributing\n\nWe **warmly welcome** all contributions!\n\n[](https://github.com/wemake-services/wemake-python-styleguide/graphs/contributors)\n\nSee [\"Contributing\"](https://wemake-python-styleguide.rtfd.io/en/latest/pages/api/index.html#contributing) section in the documentation if you want to contribute.\n\nYou 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)\nright now.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The strictest and most opinionated python linter ever",
"version": "1.3.0",
"project_urls": {
"Funding": "https://opencollective.com/wemake-python-styleguide",
"Homepage": "https://wemake-python-styleguide.rtfd.io",
"Repository": "https://github.com/wemake-services/wemake-python-styleguide"
},
"split_keywords": [
"flake8",
" flake8-plugin",
" flake8-formatter",
" linter",
" wemake.services",
" styleguide",
" code quality",
" pycqa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3875ded3793e08269a4e0e1551ff94aafc7efd32d21de442b8d3960f314955fa",
"md5": "31e806ecc50c4410645dd520d855b176",
"sha256": "3fd39228b80442f22bc4068c57930c9d468f6f5e91f52ca3b13ba5e286d63fad"
},
"downloads": -1,
"filename": "wemake_python_styleguide-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31e806ecc50c4410645dd520d855b176",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 218520,
"upload_time": "2025-07-13T06:22:43",
"upload_time_iso_8601": "2025-07-13T06:22:43.034926Z",
"url": "https://files.pythonhosted.org/packages/38/75/ded3793e08269a4e0e1551ff94aafc7efd32d21de442b8d3960f314955fa/wemake_python_styleguide-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de59489140f56e1d21c1785066f06ec19b539f5bd8f1d572983b9fdc1071979f",
"md5": "476a7b2d72a93946d2afc1ecc94e79f5",
"sha256": "b8fcbeb1271a0a324c30daca2940c4cf769b14215a57ba55412af543cc153c77"
},
"downloads": -1,
"filename": "wemake_python_styleguide-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "476a7b2d72a93946d2afc1ecc94e79f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 156768,
"upload_time": "2025-07-13T06:22:44",
"upload_time_iso_8601": "2025-07-13T06:22:44.689422Z",
"url": "https://files.pythonhosted.org/packages/de/59/489140f56e1d21c1785066f06ec19b539f5bd8f1d572983b9fdc1071979f/wemake_python_styleguide-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-13 06:22:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wemake-services",
"github_project": "wemake-python-styleguide",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wemake-python-styleguide"
}
JSON
