wemake-python-styleguide

wemake.services Supporters test codecov Python Version wemake-python-styleguide

Welcome to the strictest and most opinionated Python linter ever.

The best tool to teach your LLM how to write idiomatic and simple Python code!

wemake-python-styleguide logo

wemake-python-styleguide is actually a flake8 plugin, the only one you will need as your ruff companion.

Fully compatible with ALL rules and format conventions from ruff.

Quickstart

pip install wemake-python-styleguide

You will also need to create a setup.cfg file with the configuration.

Try it online!

We highly recommend to also use:

  • ondivi for easy integration into a legacy codebase

AI Features

wemake-python-styleguide works natively with AI tools, it is great for improving agents' code quality.

Skills:

  • /wps to run better Python code that passes wemake-python-styleguide

MCPs:

  • wps MCP helps with explaining violations and provide context on how to fix them

Additional contexts for LLMs:

See full AI docs.

Running

flake8 your_module.py --select=WPS

This app is still just good old flake8! And it won't change your existing workflow.

invocation results

See "Usage" section in the docs for examples and integrations.

We also support GitHub Actions as first class-citizens. Try it out!

Can (and should!) be used with ruff:

ruff check && ruff format
flake8 . --select=WPS

See example ruff configuration in our pyproject.toml.

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.

What we are not

We are not planning to do the following things:

  1. Assume or check types, use mypy together with our linter
  2. Format code or produce stylistic errors, use ruff format for that
  3. Check for all kinds of logical bugs, write tests instead
  4. Appeal to everyone. But, you can switch off any rules that you don't like

Supporting us :tada:

We in 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.

Gold Tier

Silver Tier

Bronze Tier

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:

wemake-python-styleguide

Markdown

[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)

Restructured text

.. 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!

List of contributors

See "Contributing" section in the documentation if you want to contribute.

You can start with issues that need some help right now.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for sobolevn from gravatar.com sobolevn

Credits

Author: Nikita Sobolev

License

MIT License (MIT)

Requires

Python <4.0, >=3.10

Provides Extra

mcp

Tags

code quality flake8 flake8-formatter flake8-plugin linter pycqa styleguide wemake.services

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wemake_python_styleguide-1.8.1.tar.gz (163.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wemake_python_styleguide-1.8.1-py3-none-any.whl (227.8 kB view details)

Uploaded Python 3

File details

Details for the file wemake_python_styleguide-1.8.1.tar.gz.

File metadata

  • Download URL: wemake_python_styleguide-1.8.1.tar.gz
  • Upload date:
  • Size: 163.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.9 Darwin/24.6.0

File hashes

Hashes for wemake_python_styleguide-1.8.1.tar.gz
Algorithm Hash digest
SHA256 a217caaf1cffe2d1168b13c405a204e82fe6c1bfc9f7d0b125dd4ce16624bc5f
MD5 716f92ab2143685db6aa28286bd80ff6
BLAKE2b-256 0f899b0637ac41f0d90ac1236ff8dacd887e0f8e3a9853abfd51e2a1319c215a

See more details on using hashes here.

File details

Details for the file wemake_python_styleguide-1.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wemake_python_styleguide-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 811355a393536583236fa25409dc639809c1bd209f66dab012eb15e9f589784e
MD5 d96473a00fb0616fff1664785ed1aa58
BLAKE2b-256 799fc953aab9187aa58669829607791731e5f3aa4b1d2b8d8051baa49dda44df

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.8.1 This release

2 files

1.8.0

2 files

1.7.1

2 files

1.7.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.19.2

2 files

0.19.1

2 files

0.19.0

2 files

0.18.0

2 files

0.17.0

2 files

0.16.1

2 files

0.16.0

2 files

0.15.3

2 files

0.15.2

2 files

0.15.1

2 files

0.15.0

2 files

0.14.1

2 files

0.14.0

2 files

0.13.4

2 files

0.13.3

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

0.12.5

2 files

0.12.4

2 files

0.12.3

2 files

0.12.2

2 files

0.12.1

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.0

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page