Skip to main content

An autohooks plugin for python code formatting via black

Project description

Greenbone Logo

autohooks-plugin-black

PyPI release

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autohooks-plugin-black-21.7.1.tar.gz (32.1 kB view details)

Uploaded Source

Built Distribution

autohooks_plugin_black-21.7.1-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file autohooks-plugin-black-21.7.1.tar.gz.

File metadata

  • Download URL: autohooks-plugin-black-21.7.1.tar.gz
  • Upload date:
  • Size: 32.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11

File hashes

Hashes for autohooks-plugin-black-21.7.1.tar.gz
Algorithm Hash digest
SHA256 e4df68d9bac84e33688fc4881243a874a3eac49fad8bcede36bd5167899d4f01
MD5 7d49fa37014f1c99df5efc8ccb754055
BLAKE2b-256 00d238bcc5bbd9ba3253e5d6a2f3601f38d9b6a4f501efc486c94a3fac1ef345

See more details on using hashes here.

Provenance

File details

Details for the file autohooks_plugin_black-21.7.1-py3-none-any.whl.

File metadata

  • Download URL: autohooks_plugin_black-21.7.1-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.11

File hashes

Hashes for autohooks_plugin_black-21.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74f615a753e365c6c5f259a884eb3e277f339e6b71a24d31158ce19a41cb28aa
MD5 eff515b5644749979ecdbe130ecc97de
BLAKE2b-256 1246980f582da48ad5bdd3de02e6fd653f1641c9cff8c636e9bc1eaa1f4a969a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page