yastyleguide 0.0.4

Yet another styleguide.

yastyleguide

Yet another styleguide

Install

From gitlab pypi repository:

Create gitlab access token.

Go to page gitlab settings. Create gitlab access token with scopes:

• api
• read-api
• read_registry
• write_registry

Set poetry http-basic authentication by token:

 poetry config http-basic.yastyleguide <gitlab-access-token-name> <gitlab-access-token>

Write to pyproject.toml:

[[tool.poetry.source]]
name = "yastyleguide"
url = "https://gitlab.com/api/v4/projects/31783240/packages/pypi/simple"
secondary = true

Install by poetry:

poetry add yastyleguide -D --source=yastyleguide

From source:

git clone https://gitlab.com/ds.team/general/yastyleguide
cd yastyleguide 
poetry build
pip install dist/yastyleguide-0.0.3.tar.gz

From dist release:

unzip artifacts.zip
pip install dist/yastyleguide-0.0.3.tar.gz

From git:

poetry add git+https://gitlab.com/ds.team/general/yastyleguide

Публичный вариант

poetry add git+https://github.com/levkovalenko/yastyleguide

Nitpick styleguide

You can use base settings for linters with nitpick:

[tool.nitpick]
style = "https://gitlab.com/ds.team/general/yastyleguide/-/blob/master/styles/nitpick-yastyle.toml"

Публичный вариант

[tool.nitpick]
style = "https://raw.githubusercontent.com/levkovalenko/yastyleguide/master/styles/nitpick-yastyle.toml"

Running

It's just plugin flake8, so:

flake8 .

Violations

Our own codes:

Code	Description
YASG101	Don't use any 'for' loops.
YASG102	Don't use any 'while' loops.
YASG201	Line is to complex, {0} > {1}. To many ast nodes per line.
YASG202	To big median line complexity in module, {0} > {1}.
YASG203	To many lines per module, {0} > {1}.
YASG204	To many function definitions per module, {0} > {1}.
YASG205	To many class definitions per module, {0} > {1}.

You can read about external plugins violations at /docs/eng/plugin_list.md