An autohooks plugin for python code formatting via black
Project description
autohooks-plugin-black
An autohooks plugin for python code formatting via black.
Installation
Install using pip
You can install the latest stable release of autohooks-plugin-black from the Python Package Index using pip:
python3 -m pip install autohooks-plugin-black
Install using poetry
It is highly encouraged to use poetry 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.
[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:
[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:
[tool.autohooks]
pre-commit = ["autohooks.plugins.black"]
[tool.autohooks.plugins.black]
arguments = ["-q", "--diff"]
Maintainer
This project is maintained by Greenbone AG.
Contributing
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
License
Copyright (C) 2019-2023 Greenbone AG
Licensed under the GNU General Public License v3.0 or later.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for autohooks_plugin_black-23.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8415b5f566d861236bde2b0973699f64a8b861208af4fa05fe04a1f923ea3ef6 |
|
MD5 | 80103b73ea8f97bf018a1828f7f36732 |
|
BLAKE2b-256 | 1c475948b7b08281498c37efe869b59cb380724aa14aa132ae70d14e584221b0 |
Hashes for autohooks_plugin_black-23.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88d648251df749586af9ea5be3105daa4358ed916b61aee738d0727387214470 |
|
MD5 | 033ae344a9ebcff92db6381536406bc5 |
|
BLAKE2b-256 | da4b8cedb513acc0ac4dbddebaa18d28861e5bbdcd3da2b6d3621f4bc99abf15 |