https://github.com/greenbone/autohooks-plugin-black
An autohooks plugin for python code formatting via black
https://github.com/greenbone/autohooks-plugin-black
autohooks autohooks-plugin base black devops formatting git githooks githooks-plugin python python3 tooling
Last synced: 6 months ago
JSON representation
An autohooks plugin for python code formatting via black
- Host: GitHub
- URL: https://github.com/greenbone/autohooks-plugin-black
- Owner: greenbone
- License: gpl-3.0
- Created: 2019-02-20T10:54:36.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T10:01:25.000Z (12 months ago)
- Last Synced: 2024-10-28T13:18:56.498Z (12 months ago)
- Topics: autohooks, autohooks-plugin, base, black, devops, formatting, git, githooks, githooks-plugin, python, python3, tooling
- Language: Python
- Homepage:
- Size: 1.32 MB
- Stars: 5
- Watchers: 9
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# autohooks-plugin-black
[](https://pypi.org/project/autohooks-plugin-black/)
An [autohooks](https://github.com/greenbone/autohooks) plugin for python code
formatting via [black](https://github.com/ambv/black).
## Installation
### Install using pip
You can install the latest stable release of autohooks-plugin-black from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install autohooks-plugin-black
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-black is
installed as a development dependency.
poetry add --dev autohooks-plugin-black
## Usage
To activate the black autohooks plugin please add the following setting to your
*pyproject.toml* file.
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.black"]
```
By default, autohooks plugin black 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.black"]
[tool.autohooks.plugins.black]
include = ['foo/*.py', '*.foo']
```
Also by default, autohooks plugin black executes black with the `-q` argument.
If e.g. the generated patch should be shown the following setting can be used:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.black"]
[tool.autohooks.plugins.black]
arguments = ["-q", "--diff"]
```
## 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-black/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-black/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).