Repository files navigation

Welcome to the strictest and most opinionated Python linter ever.

wemake-python-styleguide is actually aflake8plugin, the only one you will need as yourruff companion.

Fully compatible withALL rules and format conventions fromruff.

pip install wemake-python-styleguide

You will also need to create asetup.cfg file with theconfiguration.

Try it online!

We highly recommend to also use:

• ondivi for easy integration into alegacy codebase

flake8 your_module.py --select=WPS

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

See"Usage" sectionin the docs for examples and integrations.

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

Can (and should!) be used withruff:

ruff check&& ruff formatflake8. --select=WPS

See exampleruff configuration in ourpyproject.toml.

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

The ultimate goal of this project isto make all people writeexactly the samePython code.

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 pluginsin the docs.

We arenot planning to do the following things:

0. Assume or check types, usemypy together with our linter
1. Format code or produce stylistic errors, useruff format for that
2. Check forSyntaxError or logical bugs, write tests instead
3. Appeal to everyone. But, you canswitch off any rules that you don't like

We inwemake.services makeall 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.

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 othersby including a badge in yourREADME file. It looks like this:

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

..image::https://img.shields.io/badge/style-wemake-000000.svg:target:https://github.com/wemake-services/wemake-python-styleguide

Wewarmly welcome all contributions!

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

You can start withissues that need some helpright now.