yastyleguide

Name	yastyleguide JSON
Version	0.2.0 JSON
	download
home_page	https://github.com/levkovalenko/yastyleguide
Summary	Yet another styleguide.
upload_time	2023-03-15 17:22:02
maintainer
docs_url	None
author	levkovalenko
requires_python	>=3.9,<4.0
license	MIT
keywords	flake8 flake8-plugin linter yastyleguide styleguide code quality pycqa
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # yastyleguide
Yet another styleguide


## Install

```bash
poetry add -D yastyleguide
```

```bash
pip install yastyleguide
```

## Nitpick styleguide

You can use base settings for linters with [nitpick](https://github.com/andreoliwa/nitpick):
```toml
[tool.nitpick]
style = "https://raw.githubusercontent.com/levkovalenko/yastyleguide-styles/master/nitpick-yastyle.toml"
```

## Running
It's just plugin **flake8**, so:
```bash
flake8 .
```

## Violations
Our own codes:
|Code|Description|
|----|-----------|
|YAS101|`Don't use any 'for' loops.`|
|YAS102|`Don't use any 'while' loops.`|
|YAS201|`Line is to complex, {0} > {1}. To many ast nodes per line.`|

*temporary disabled*
|YAS202|`To big median line complexity in module, {0} > {1}.`|
|YAS203|`To many lines per module, {0} > {1}.`|
|YAS204|`To many function definitions per module, {0} > {1}.`|
|YAS205|`To many class definitions per module, {0} > {1}.`|

You can read about external plugins violations at [/docs/eng/plugin_list.md](docs/eng/plugin_list.md)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/levkovalenko/yastyleguide",
    "name": "yastyleguide",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "flake8,flake8-plugin,linter,yastyleguide,styleguide,code quality,pycqa",
    "author": "levkovalenko",
    "author_email": "levozavr@mail.ru",
    "download_url": "https://files.pythonhosted.org/packages/a3/17/96ef6412c66907696032b5aec3ac572bf91e3f3f9547c9367360e59017ba/yastyleguide-0.2.0.tar.gz",
    "platform": null,
    "description": "# yastyleguide\nYet another styleguide\n\n\n## Install\n\n```bash\npoetry add -D yastyleguide\n```\n\n```bash\npip install yastyleguide\n```\n\n## Nitpick styleguide\n\nYou can use base settings for linters with [nitpick](https://github.com/andreoliwa/nitpick):\n```toml\n[tool.nitpick]\nstyle = \"https://raw.githubusercontent.com/levkovalenko/yastyleguide-styles/master/nitpick-yastyle.toml\"\n```\n\n## Running\nIt's just plugin **flake8**, so:\n```bash\nflake8 .\n```\n\n## Violations\nOur own codes:\n|Code|Description|\n|----|-----------|\n|YAS101|`Don't use any 'for' loops.`|\n|YAS102|`Don't use any 'while' loops.`|\n|YAS201|`Line is to complex, {0} > {1}. To many ast nodes per line.`|\n\n*temporary disabled*\n|YAS202|`To big median line complexity in module, {0} > {1}.`|\n|YAS203|`To many lines per module, {0} > {1}.`|\n|YAS204|`To many function definitions per module, {0} > {1}.`|\n|YAS205|`To many class definitions per module, {0} > {1}.`|\n\nYou can read about external plugins violations at [/docs/eng/plugin_list.md](docs/eng/plugin_list.md)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Yet another styleguide.",
    "version": "0.2.0",
    "split_keywords": [
        "flake8",
        "flake8-plugin",
        "linter",
        "yastyleguide",
        "styleguide",
        "code quality",
        "pycqa"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab35ecfdf03e3c9abb0e2fca69b234ac3357bbc31387bc43fef8bd18461c191f",
                "md5": "4ba969fc28a49ee6c17846bc36c23037",
                "sha256": "e7da693e979ce87089801065f8e63b081a55e3e9fc944fa0df5e12cad67abf5c"
            },
            "downloads": -1,
            "filename": "yastyleguide-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4ba969fc28a49ee6c17846bc36c23037",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 12062,
            "upload_time": "2023-03-15T17:22:00",
            "upload_time_iso_8601": "2023-03-15T17:22:00.337151Z",
            "url": "https://files.pythonhosted.org/packages/ab/35/ecfdf03e3c9abb0e2fca69b234ac3357bbc31387bc43fef8bd18461c191f/yastyleguide-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a31796ef6412c66907696032b5aec3ac572bf91e3f3f9547c9367360e59017ba",
                "md5": "562e3d9d71bc5721c10ff0d32bb037f8",
                "sha256": "b1bed544b1b47caae865d5d0ff0bacafbf44349e14bef817892029352e248b1a"
            },
            "downloads": -1,
            "filename": "yastyleguide-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "562e3d9d71bc5721c10ff0d32bb037f8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 8499,
            "upload_time": "2023-03-15T17:22:02",
            "upload_time_iso_8601": "2023-03-15T17:22:02.054584Z",
            "url": "https://files.pythonhosted.org/packages/a3/17/96ef6412c66907696032b5aec3ac572bf91e3f3f9547c9367360e59017ba/yastyleguide-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-15 17:22:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "levkovalenko",
    "github_project": "yastyleguide",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "yastyleguide"
}