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.3.tar.gz (161.0 kB view details)

Uploaded Source

Built Distribution

wemake_python_styleguide-0.15.3-py3-none-any.whl (213.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wemake-python-styleguide-0.15.3.tar.gz
Algorithm Hash digest
SHA256 8b89aedabae67b7b915908ed06c178b702068137c0d8afe1fb59cdc829cd2143
MD5 9e6ba80db418c76d9f0b9117b80eb666
BLAKE2b-256 1e5c9918d3acf333b6f7788335b4e3bdd83a9a5ba1a4846b5733448a8fdc194b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wemake_python_styleguide-0.15.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a382f6c9ec87d56daa08a11e47cab019c99b384f1393b32564ebc74c6da80441
MD5 e0a0405fb3468106fda9b4f35c7cff67
BLAKE2b-256 51379254075b121e57295f36ea792093b9c05317466fd94875ec297781f17cac

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