Welcome to the strictest and most opinionated python linter ever.
wemake-python-styleguide is actually a
with some other plugins as dependencies.
The Zen of Python, by Tim Peters Beautiful is better than ugly. Explicit is better than implicit. Simple is better than complex. Complex is better than complicated. Flat is better than nested. Sparse is better than dense. Readability counts. Special cases aren't special enough to break the rules. Although practicality beats purity. Errors should never pass silently. Unless explicitly silenced. In the face of ambiguity, refuse the temptation to guess. There should be one-- and preferably only one --obvious way to do it. Although that way may not be obvious at first unless you're Dutch. Now is better than never. Although never is often better than *right* now. If the implementation is hard to explain, it's a bad idea. If the implementation is easy to explain, it may be a good idea. Namespaces are one honking great idea -- let's do more of those!
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.
This app is still just good old
And it won't change your existing workflow.
See "Usage" section in the docs for examples and integrations.
What we are about
We have several primary objectives:
- 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.
What we are not
We are not planning to do the following things:
- Assume or check types, use
- Reformat code, since we believe that developers should do that
- Check for
SyntaxErroror exceptions, write tests instead
- Appeal to everyone, this is our linter. But, you can switch off any rules that you don't like
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 to your
It looks like this:
.. image:: https://img.shields.io/badge/style-wemake-000000.svg :target: https://github.com/wemake-services/wemake-python-styleguide
We warmly welcome all contributions!