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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae2dbda4f8598f8265ef74bcbcf7f14b07d97575368ec8ae03e0fbda32d783dd |
|
MD5 | dd79042ea6f4f25306a5d231c1357860 |
|
BLAKE2b-256 | d149652573db494bba7a8f184cb4f8663a238055989ad965375af1e6863397e5 |
Hashes for autohooks_plugin_black-23.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ce7c25de7da08adf6293b5afa412f4331fc024ff4d872b9daa3247d280eda03 |
|
MD5 | 8de148f40021e6ab91d3a553d0832a8d |
|
BLAKE2b-256 | f1d636a3daf7bc6b8e5bac48a40b51c43cfa6b12708467d4035f18b29942b2ba |