The strictest and most opinionated python linter ever
Welcome to the strictest and most opinionated Python linter ever.
wemake-python-styleguide
is actually a flake8
plugin with some other plugins as dependencies.
pip install wemake-python-styleguide
You will also need to create a setup.cfg
file with the configuration.
We highly recommend to also use:
flake8 your_module.py
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!
Strict linting offers the following benefits to developers and companies:
The ultimate goal of this project is
to make all people write exactly the same Python
code.
flake8 | pylint | black | mypy | 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:
python3.7+
usageYou can find all error codes and plugins in the docs.
We are not planning to do the following things:
mypy
together with our linterSyntaxError
or logical bugs, write tests insteadWe 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.
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](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
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.