README.md

autohooks-plugin-ruff

An autohooks plugin for python code formatting via ruff.

Installation

Install using pip

[!NOTE] The pip install command does no longer work out-of-the-box in newer distributions like Ubuntu >= 23.04 because of PEP 668.

You can install the latest stable release of autohooks-plugin-ruff from the Python Package Index using pip:

python3 -m pip install --user autohooks-plugin-ruff

Install using poetry

It is highly encouraged to use poetry for maintaining your project's dependencies. Normally autohooks-plugin-ruff is installed as a development dependency.

poetry add --group dev autohooks-plugin-ruff

Usage

To activate the ruff autohooks plugin please run

poetry run autohooks plugins add autohooks.plugins.ruff

or alternatively add the following setting to your pyproject.toml file.

[tool.autohooks]
pre-commit = ["autohooks.plugins.ruff"]

What the plugin actually does is ruff check . on git commit, so you should be able to use the exact same settings as in ruff's docs.

Notes

This project only runs ruff as a pre-commit hook, so, all features from ruff should be available too.

To activate this pre-commit hook remember to run this command before you start:

poetry run autohooks activate --mode poetry

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) 2023 - 2024 Greenbone AG

Licensed under the GNU General Public License v3.0 or later.