Skip to main content

The strictest and most opinionated python linter ever

Project description

wemake-python-styleguide

wemake.services Supporters Build Status Coverage 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 resuts

See "Usage" section in the docs for examples and integrations.

What we are about

The ultimate goal of this project is to make all people write exactly the same python code.

black mypy pylint flake8 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

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

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

Uploaded Source

Built Distribution

wemake_python_styleguide-0.12.1-py3-none-any.whl (487.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wemake-python-styleguide-0.12.1.tar.gz
  • Upload date:
  • Size: 113.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.11 CPython/3.7.3 Darwin/18.6.0

File hashes

Hashes for wemake-python-styleguide-0.12.1.tar.gz
Algorithm Hash digest
SHA256 dff29897d3cb77309cb867c122dbaadba7fb83e8f1a54e0d790bc4a5e261f3cf
MD5 865e1eaa98781dab32af2f3730ee7e30
BLAKE2b-256 09f611e2ead64fabbbee54ff843610f298c45b1b236c4839665b05def5c7d96a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wemake_python_styleguide-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aabdea7bc226dc27672760f29bfc2bb0cf22b1633e1ea33c03b88637889ef91f
MD5 6ce1082c88b1e3fc7217d7a21dc37007
BLAKE2b-256 7753d54b22aa88ac5953f655187db506921242d59b4cdf1dfdada5318ece9403

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