Metadata-Version: 2.1
Name: wemake-python-styleguide
Version: 0.0.3
Summary: Opinionated styleguide that we use in wemake.services
Home-page: https://github.com/wemake-services/wemake-python-styleguide
License: MIT
Keywords: flake8,plugin,wemake.services,styleguide
Author: Nikita Sobolev
Author-email: mail@sobolevn.me
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: flake8 (>=3.5,<4.0)
Description-Content-Type: text/markdown

# wemake-python-styleguide

[![wemake.services](https://img.shields.io/badge/style-wemake.services-green.svg?label=&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](http://wemake.services)
[![Build Status](https://travis-ci.org/wemake-services/wemake-python-styleguide.svg?branch=master)](https://travis-ci.org/wemake-services/wemake-python-styleguide)
[![Coverage](https://coveralls.io/repos/github/wemake-services/wemake-python-styleguide/badge.svg?branch=master)](https://coveralls.io/github/wemake-services/wemake-python-styleguide?branch=master)
[![PyPI version](https://badge.fury.io/py/wemake-python-styleguide.svg)](https://badge.fury.io/py/wemake-python-styleguide)
[![Documentation Status](https://readthedocs.org/projects/wemake-python-styleguide/badge/?version=latest)](https://wemake-python-styleguide.readthedocs.io/en/latest/?badge=latest)


Welcome to the most opinionated linter ever.


## Installation

```bash
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:

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

```sh
flake8 --max-returns 7
```

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

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


