Opinionated styleguide that we use in wemake.services
Project description
wemake-python-styleguide
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 ofreturn
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wemake-python-styleguide-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a764c057e34ff3e693394c48b1c89733c89885b6c3d1eb33a7c74ab89982612 |
|
MD5 | 72449c2f7668d4a6e6c609c9d5270f30 |
|
BLAKE2b-256 | fbad3ecfe945366f64e01928c8e7f42c6def6d776ceb5dfff8dc06bebab6cdec |
Hashes for wemake_python_styleguide-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30f7b18d7c008d089c67613ad70189f9020076bf56cb5a0fbffa83407f24d4f0 |
|
MD5 | 86c936c419bcc6fe94b8df19ae5854d6 |
|
BLAKE2b-256 | 3b36ab184fc85d45dd085876e37c2003e01c1d5e44421b4678386e0ad49233cc |