autohooks-plugin-flake8


Nameautohooks-plugin-flake8 JSON
Version 23.10.0 PyPI version JSON
download
home_pagehttps://github.com/greenbone/autohooks-plugin-flake8
SummaryAn autohooks plugin for python code linting via flake8.
upload_time2023-10-18 08:47:01
maintainer
docs_urlNone
authorGreenbone AG
requires_python>=3.9,<4.0
licenseGPL-3.0-or-later
keywords git linting hooks flake8
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)

# autohooks-plugin-flake8

[![PyPI release](https://img.shields.io/pypi/v/autohooks-plugin-flake8.svg)](https://pypi.org/project/autohooks-plugin-flake8/)

An [autohooks](https://github.com/greenbone/autohooks) plugin for python code
linting via [flake8](https://github.com/PyCQA/flake8).

## Installation

### Install using pip

You can install the latest stable release of autohooks-plugin-flake8 from the
Python Package Index using [pip](https://pip.pypa.io/):

    python3 -m pip install autohooks-plugin-flake8

### Install using poetry

It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-flake8 is
installed as a development dependency.

    poetry install

## Usage

To activate the flake8 autohooks plugin please add the following setting to your
*pyproject.toml* file.

```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.flake8"]
```

By default, autohooks plugin flake8 checks all files with a *.py* ending. If
only files in a sub-directory or files with different endings should be
formatted, just add the following setting:

```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.flake8"]

[tool.autohooks.plugins.flake8]
include = ['foo/*.py', '*.foo']
```

To configure flake8 you can specify command-line options in the default flake8
configuration file *.flake8* in the root directory of the git repository.
To learn more about flake8 configuration see the configuration file or
the flake8 documentation. You can specify your own configuration file using

```
arguments = ["--config=/path/to/flake8config"]
```

inside the `[tool.autohooks.plugins.flake8]` section of your projects `pyproject.toml`.

See `flake8 --help` for more details.

## Maintainer

This project is maintained by [Greenbone AG](https://www.greenbone.net/).

## Contributing

Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/autohooks-plugin-flake8/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-flake8/issues)
first.

## License

Copyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)

Licensed under the [GNU General Public License v3.0 or later](LICENSE).

SPDX-License-Identifier: GPL-3.0-or-later

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/greenbone/autohooks-plugin-flake8",
    "name": "autohooks-plugin-flake8",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "git,linting,hooks,flake8",
    "author": "Greenbone AG",
    "author_email": "info@greenbone.net",
    "download_url": "https://files.pythonhosted.org/packages/7a/58/23c9603eb32ea71c2837af10e591460ca085b7600fe55efc70ff1a565fcf/autohooks_plugin_flake8-23.10.0.tar.gz",
    "platform": null,
    "description": "![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# autohooks-plugin-flake8\n\n[![PyPI release](https://img.shields.io/pypi/v/autohooks-plugin-flake8.svg)](https://pypi.org/project/autohooks-plugin-flake8/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nlinting via [flake8](https://github.com/PyCQA/flake8).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-flake8 from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n    python3 -m pip install autohooks-plugin-flake8\n\n### Install using poetry\n\nIt is highly encouraged to use [poetry](https://python-poetry.org) for\nmaintaining your project's dependencies. Normally autohooks-plugin-flake8 is\ninstalled as a development dependency.\n\n    poetry install\n\n## Usage\n\nTo activate the flake8 autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.flake8\"]\n```\n\nBy default, autohooks plugin flake8 checks all files with a *.py* ending. If\nonly files in a sub-directory or files with different endings should be\nformatted, just add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.flake8\"]\n\n[tool.autohooks.plugins.flake8]\ninclude = ['foo/*.py', '*.foo']\n```\n\nTo configure flake8 you can specify command-line options in the default flake8\nconfiguration file *.flake8* in the root directory of the git repository.\nTo learn more about flake8 configuration see the configuration file or\nthe flake8 documentation. You can specify your own configuration file using\n\n```\narguments = [\"--config=/path/to/flake8config\"]\n```\n\ninside the `[tool.autohooks.plugins.flake8]` section of your projects `pyproject.toml`.\n\nSee `flake8 --help` for more details.\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/autohooks-plugin-flake8/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-flake8/issues)\nfirst.\n\n## License\n\nCopyright (C) 2019 - 2023 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\nSPDX-License-Identifier: GPL-3.0-or-later\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-or-later",
    "summary": "An autohooks plugin for python code linting via flake8.",
    "version": "23.10.0",
    "project_urls": {
        "Homepage": "https://github.com/greenbone/autohooks-plugin-flake8",
        "Repository": "https://github.com/greenbone/autohooks-plugin-flake8"
    },
    "split_keywords": [
        "git",
        "linting",
        "hooks",
        "flake8"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "968cc097cdfba8436f83e6555f4f23f48f1730f68b044e545ecac4b5436473b6",
                "md5": "34c16e011e9fce199f935662f5d3a378",
                "sha256": "6e0de03d0b78abf8e50ca62ca123035ddc9b91d01bca2df56a06249c4b3bba99"
            },
            "downloads": -1,
            "filename": "autohooks_plugin_flake8-23.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "34c16e011e9fce199f935662f5d3a378",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 17325,
            "upload_time": "2023-10-18T08:46:59",
            "upload_time_iso_8601": "2023-10-18T08:46:59.731753Z",
            "url": "https://files.pythonhosted.org/packages/96/8c/c097cdfba8436f83e6555f4f23f48f1730f68b044e545ecac4b5436473b6/autohooks_plugin_flake8-23.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7a5823c9603eb32ea71c2837af10e591460ca085b7600fe55efc70ff1a565fcf",
                "md5": "9e39a4f662bf33ed5d82c3b1c77f858a",
                "sha256": "2f586a408a2a5daa36b13c5a0c4bc1703152218e4ef58996a8391c61c354f402"
            },
            "downloads": -1,
            "filename": "autohooks_plugin_flake8-23.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9e39a4f662bf33ed5d82c3b1c77f858a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 16959,
            "upload_time": "2023-10-18T08:47:01",
            "upload_time_iso_8601": "2023-10-18T08:47:01.806802Z",
            "url": "https://files.pythonhosted.org/packages/7a/58/23c9603eb32ea71c2837af10e591460ca085b7600fe55efc70ff1a565fcf/autohooks_plugin_flake8-23.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-18 08:47:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "greenbone",
    "github_project": "autohooks-plugin-flake8",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "autohooks-plugin-flake8"
}
Greenbone AG
Elapsed time: 0.14481s