wemake-services/wemake-python-styleguide
The strictest and most opinionated python linter ever! - wemake-services/wemake-python-styleguide
2.9k stars · 426 forks
README
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 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
Additional contexts for LLMs:
https://wemake-python-styleguide.readthedocs.io/llms.txt https://wemake-python-styleguide.readthedocs.io/llms-full.txt
Running flake8 your_module.py --select=WPS This app is still just good old flake8! And it won't change your existing workflow.
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:
Ensures consistency - no matter who works on it, the end product will always be the same dependable code Helps avoid potential bugs - strict rules make sure that you don't make common mistakes 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! Fewer code revisions - strict linting ensures that you don't have to re-write the codebase again and again 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:
Significantly reduce the complexity of your code and make it more maintainable Enforce "There should be one -- and preferably only one -- obvious way to do it" rule to coding and naming styles 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:
Assume or check types, use mypy together with our linter Format code or produce stylistic errors, use ruff format for that Check for all kinds of logical bugs, write tests instead Appeal to everyone. But, you can switch off any rules that you don't like
Supporting us 🎉 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.
Show your style 😎 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:
Markdown
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!
See "Contributing" section in the documentation if you want to contribute. You can start with issues that need some help right now.