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:
pip install autohooks-plugin-black
Note the pip
refers to the Python 3 package manager. In a environment where
Python 2 is also available the correct command may be pip3
.
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 Networks GmbH.
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 Greenbone Networks GmbH
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-22.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 631ff2bb4943dfcb6f738481552e55e5b288a4955a7acbefb158d8a98ec3a93b |
|
MD5 | 0a31ed5f646beebd30f6f9983aaa2d10 |
|
BLAKE2b-256 | 8ee7552df89abb4d97079acaf6b2084d13af4d02c39989e5b869896309c873a1 |
Hashes for autohooks_plugin_black-22.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0fd0cae8803eef5652da05f55939cdb27eb53e5980b873abeab61dd87841861 |
|
MD5 | fd1921a7c7b0f265e29f4e0664e1d54a |
|
BLAKE2b-256 | 2475f8f423dfd4a9dda3f1a2485f5b29e3428db3211909c85b1814971c05c5e3 |