https://github.com/greenbone/autohooks-plugin-flake8
Autohooks plugin for flake8
https://github.com/greenbone/autohooks-plugin-flake8
autohooks autohooks-plugin automation base devops python
Last synced: 9 months ago
JSON representation
Autohooks plugin for flake8
- Host: GitHub
- URL: https://github.com/greenbone/autohooks-plugin-flake8
- Owner: greenbone
- License: gpl-3.0
- Created: 2022-01-27T11:40:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-07T10:32:30.000Z (9 months ago)
- Last Synced: 2025-07-07T11:37:22.654Z (9 months ago)
- Topics: autohooks, autohooks-plugin, automation, base, devops, python
- Language: Python
- Homepage:
- Size: 750 KB
- Stars: 2
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# autohooks-plugin-flake8
[](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