Skip to main content

Opinionated styleguide that we use in wemake.services

Project description

wemake-python-styleguide

wemake.services Build Status Coverage PyPI version Documentation Status

Welcome to the most opinionated linter ever.

wemake-python-styleguide is actually just a flake8 plugin. The main goal of this tool is to make our python code consistent.

Installation

pip install wemake-python-styleguide

Project status

We are in early alpha. Use it on your own risk.

Running tests

Clone the repository, install poetry, then do from within the project folder:

# Installing dependencies (only required to be run once):
poetry install
poetry develop

# Running tests:
poetry run pytest
poetry run mypy wemake_python_styleguide
poetry run doc8 -q docs

It's OK if some tests are skipped.

Configuration

You can adjust configuration via CLI option:

flake8 --max-returns 7

or configuration option in tox.ini/setup.cfg.

max-returns = 7

There are the following options:

  • max-returns - maximum allowed number of return statements in one function. Default value is 6.

  • max-local-variables - maximum allowed number of local variables in one function. Default is 10.

  • max-expressions - maximum allowed number of expressions in one function. Default value is 10.

  • max-arguments - maximum allowed number of arguments in one function. Default value is 5.

Project details


Download files

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

Files for wemake-python-styleguide, version 0.0.5
Filename, size File type Python version Upload date Hashes
Filename, size wemake_python_styleguide-0.0.5-py3-none-any.whl (45.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wemake-python-styleguide-0.0.5.tar.gz (13.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page