Skip to main content

The strictest and most opinionated python linter ever

Project description

wemake-python-styleguide

wemake.services Supporters Build Status codecov Python Version wemake-python-styleguide


Welcome to the strictest and most opinionated python linter ever.

wemake-python-styleguide logo

wemake-python-styleguide is actually a flake8 plugin with some other plugins as dependencies.

Quickstart

pip install wemake-python-styleguide

You will also need to create a setup.cfg file with the configuration.

We highly recommend to also use:

  • flakehell for easy integration into a legacy codebase
  • nitpick for sharing and validating configuration across multiple projects

Running

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 in the docs for examples and integrations.

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

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:

  1. Enforce python3.6+ usage
  2. Significantly reduce complexity of your code and make it more maintainable
  3. Enforce "There should be one -- and preferably only one -- obvious way to do it" rule to coding and naming styles
  4. 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:

  1. Assume or check types, use mypy together with our linter
  2. Reformat code, since we believe that developers should do that
  3. Check for SyntaxError or logical bugs, write tests instead
  4. Appeal to everyone. But, you can switch off any rules that you don't like

Supporting us :tada:

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

Gold Tier

Silver Tier

Bronze Tier

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 to your README file. It looks like this:

wemake-python-styleguide

Markdown

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

Restructured text

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

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

You can start with issues that need some help right now.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wemake-python-styleguide-0.15.0.tar.gz (158.2 kB view details)

Uploaded Source

Built Distribution

wemake_python_styleguide-0.15.0-py3-none-any.whl (209.0 kB view details)

Uploaded Python 3

File details

Details for the file wemake-python-styleguide-0.15.0.tar.gz.

File metadata

  • Download URL: wemake-python-styleguide-0.15.0.tar.gz
  • Upload date:
  • Size: 158.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.1 Darwin/18.7.0

File hashes

Hashes for wemake-python-styleguide-0.15.0.tar.gz
Algorithm Hash digest
SHA256 c8a3f426cd621f03fb3cc41cbd6754548d1db49bef245bc9a589c20dbff81aff
MD5 b443a76ef26d0e038d5424d6af9d5916
BLAKE2b-256 9c0f5a417d739af48fa2a9c814b4ed48ad3dd0a406bea44eb1f84e6fc0558b81

See more details on using hashes here.

File details

Details for the file wemake_python_styleguide-0.15.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wemake_python_styleguide-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3911a78c3475ab388da45c6291ac4130e4b862d807666aaa3997b2e833da6db8
MD5 69e0569474a58334454d2c4c1ab939c8
BLAKE2b-256 97263bb11f48e2b5a2e3a6d685f34bd0d5885b0669ab6c5529b447126f1f5f52

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page