# 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/autohooks-plugin-black",
"name": "autohooks-plugin-black",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "git,formatting,linting,hooks,black",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/1c/47/5948b7b08281498c37efe869b59cb380724aa14aa132ae70d14e584221b0/autohooks_plugin_black-23.10.0.tar.gz",
"platform": null,
"description": "\n\n# autohooks-plugin-black\n\n[](https://pypi.org/project/autohooks-plugin-black/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nformatting via [black](https://github.com/ambv/black).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-black from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n python3 -m pip install autohooks-plugin-black\n\n### Install using poetry\n\nIt is highly encouraged to use [poetry](https://python-poetry.org) for\nmaintaining your project's dependencies. Normally autohooks-plugin-black is\ninstalled as a development dependency.\n\n poetry add --dev autohooks-plugin-black\n\n## Usage\n\nTo activate the black autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.black\"]\n```\n\nBy default, autohooks plugin black checks all files with a *.py* ending. If only\nfiles in a sub-directory or files with different endings should be formatted,\njust add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.black\"]\n\n[tool.autohooks.plugins.black]\ninclude = ['foo/*.py', '*.foo']\n```\n\nAlso by default, autohooks plugin black executes black with the `-q` argument.\nIf e.g. the generated patch should be shown the following setting can be used:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.black\"]\n\n[tool.autohooks.plugins.black]\narguments = [\"-q\", \"--diff\"]\n```\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/autohooks-plugin-black/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-black/issues)\nfirst.\n\n## License\n\nCopyright (C) 2019-2023 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An autohooks plugin for python code formatting via black",
"version": "23.10.0",
"project_urls": {
"Homepage": "https://github.com/greenbone/autohooks-plugin-black",
"Repository": "https://github.com/greenbone/autohooks-plugin-black"
},
"split_keywords": [
"git",
"formatting",
"linting",
"hooks",
"black"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da4b8cedb513acc0ac4dbddebaa18d28861e5bbdcd3da2b6d3621f4bc99abf15",
"md5": "033ae344a9ebcff92db6381536406bc5",
"sha256": "88d648251df749586af9ea5be3105daa4358ed916b61aee738d0727387214470"
},
"downloads": -1,
"filename": "autohooks_plugin_black-23.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "033ae344a9ebcff92db6381536406bc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 16979,
"upload_time": "2023-10-18T08:46:29",
"upload_time_iso_8601": "2023-10-18T08:46:29.697672Z",
"url": "https://files.pythonhosted.org/packages/da/4b/8cedb513acc0ac4dbddebaa18d28861e5bbdcd3da2b6d3621f4bc99abf15/autohooks_plugin_black-23.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c475948b7b08281498c37efe869b59cb380724aa14aa132ae70d14e584221b0",
"md5": "80103b73ea8f97bf018a1828f7f36732",
"sha256": "8415b5f566d861236bde2b0973699f64a8b861208af4fa05fe04a1f923ea3ef6"
},
"downloads": -1,
"filename": "autohooks_plugin_black-23.10.0.tar.gz",
"has_sig": false,
"md5_digest": "80103b73ea8f97bf018a1828f7f36732",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 33384,
"upload_time": "2023-10-18T08:46:30",
"upload_time_iso_8601": "2023-10-18T08:46:30.947663Z",
"url": "https://files.pythonhosted.org/packages/1c/47/5948b7b08281498c37efe869b59cb380724aa14aa132ae70d14e584221b0/autohooks_plugin_black-23.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-18 08:46:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "autohooks-plugin-black",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autohooks-plugin-black"
}
JSON
