Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/wemake-services/wemake-python-styleguide

The strictest and most opinionated python linter ever!
https://github.com/wemake-services/wemake-python-styleguide

code-quality flake8 flake8-plugin hacktoberfest linter python python3 styleguide wemake wemake-services

Last synced: about 1 month ago
JSON representation

The strictest and most opinionated python linter ever!

Lists

README 

        
# wemake-python-styleguide



[![wemake.services](https://img.shields.io/badge/%20-wemake.services-green.svg?label=%20&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](https://wemake-services.github.io)

[![Supporters](https://img.shields.io/opencollective/all/wemake-python-styleguide.svg?color=gold&label=supporters)](https://opencollective.com/wemake-python-styleguide)

[![Build Status](https://github.com/wemake-services/wemake-python-styleguide/workflows/test/badge.svg?branch=master&event=push)](https://github.com/wemake-services/wemake-python-styleguide/actions?query=workflow%3Atest)

[![codecov](https://codecov.io/gh/wemake-services/wemake-python-styleguide/branch/master/graph/badge.svg)](https://codecov.io/gh/wemake-services/wemake-python-styleguide)

[![Python Version](https://img.shields.io/pypi/pyversions/wemake-python-styleguide.svg)](https://pypi.org/project/wemake-python-styleguide/)

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



---



Welcome to the strictest and most opinionated Python linter ever.





  

    wemake-python-styleguide logo

  




`wemake-python-styleguide` is actually a [flake8](http://flake8.pycqa.org/en/latest/)

plugin with [some other plugins](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/violations/index.html#external-plugins) as dependencies.



## Quickstart



```bash

pip install wemake-python-styleguide

```



You will also need to create a `setup.cfg` file with the [configuration](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/configuration.html).



[Try it online](https://wps.orsinium.dev)!



We highly recommend to also use:



- [flakeheaven](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/flakeheaven.html) for easy integration into a **legacy** codebase

- [nitpick](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/nitpick.html) for sharing and validating configuration across multiple projects



## Running



```bash

flake8 your_module.py

```



This app is still just good old `flake8`!

And it won't change your existing workflow.





  invocation results




See ["Usage" section](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/setup.html)

in the docs for examples and integrations.



We also support [GitHub Actions](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/github-actions.html) as first class-citizens.

[Try it out](https://github.com/marketplace/actions/wemake-python-styleguide)!



## Strict is the new cool



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



## 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 | 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:



0. Enforce `python3.7+` usage

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 plugins [in the docs](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/violations/index.html).



## What we are not



We are *not* planning to do the following things:



0. Assume or check types, use `mypy` together with our linter

1. [Reformat code](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/integrations/auto-formatters.html), since we believe that developers should do that

2. Check for `SyntaxError` or logical bugs, write tests instead

3. Appeal to everyone. But, you can [switch off](https://wemake-python-styleguide.rtfd.io/en/latest/pages/usage/setup.html#ignoring-violations) any rules that you don't like



## Supporting us :tada:



We in [wemake.services](https://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.



[![Gold Tier](https://opencollective.com/wemake-python-styleguide/tiers/gold-sponsor.svg?width=890)](https://opencollective.com/wemake-python-styleguide)



[![Silver Tier](https://opencollective.com/wemake-python-styleguide/tiers/silver-sponsor.svg?width=890&avatarHeight=45&button=0)](https://opencollective.com/wemake-python-styleguide)



[![Bronze Tier](https://opencollective.com/wemake-python-styleguide/tiers/bronze-sponsor.svg?width=890&avatarHeight=35&button=0)](https://opencollective.com/wemake-python-styleguide)



## Show your style :sunglasses:



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)



### Markdown



```md

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

```



### Restructured text



```rst

.. 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!



[![List of contributors](https://opencollective.com/wemake-python-styleguide/contributors.svg?width=890&button=0)](https://github.com/wemake-services/wemake-python-styleguide/graphs/contributors)



See ["Contributing"](https://wemake-python-styleguide.rtfd.io/en/latest/pages/api/index.html#contributing) section in the documentation if you want to contribute.



You can start with [issues that need some help](https://github.com/wemake-services/wemake-python-styleguide/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

right now.