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 following contents.
This file is required to configure our linter and all 3rd party plugins it uses. However, this is a temporary solution. We are working at providing the required configuration for you in the future.
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.
black | pylint | flake8 | wemake-python-styleguide | |
---|---|---|---|---|
Formats code? | ✅ | ❌ | ❌ | ❌ |
Finds bugs? | ❌ | ✅ | ✅ | ✅ |
Finds complex code? | ❌ | ✅ | ✅ | ✅ |
Has a lot of strict rules? | ❌ | 🤔 | ❌ | ✅ |
Has a lot of plugins? | ❌ | ❌ | ✅ | ✅ |
We have several primary objectives:
- Enforce
python3.6+
usage - Significantly reduce 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.
We are not planning to do the following things:
- Assume or check types, use
mypy
instead - Reformat code, since we believe that developers should do that
- Check for
SyntaxError
or exceptions, write tests instead - Appeal to everyone, this is our linter. But, you can switch off any rules that you don't like
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 to 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.