# autohooks-plugin-ruff
[](https://pypi.org/project/autohooks-plugin-ruff/)
An [autohooks](https://github.com/greenbone/autohooks) plugin for python code
formatting via [ruff](https://github.com/astral-sh/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](https://peps.python.org/pep-0668).
You can install the latest stable release of autohooks-plugin-ruff from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install --user autohooks-plugin-ruff
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) 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
```shell
poetry run autohooks plugins add autohooks.plugins.ruff
```
or alternatively add the following setting to your
*pyproject.toml* file.
```toml
[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](https://beta.ruff.rs/docs/settings/).
## 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:
```shell
poetry run autohooks activate --mode poetry
```
## 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-ruff/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-ruff/issues)
first.
## License
Copyright (C) 2023 - 2024 [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-ruff",
"name": "autohooks-plugin-ruff",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "git,formatting,linting,hooks,ruff",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/e0/f6/9e32e22520393d3fe0d910b78ee84e738cfb27d5227613bb6a8d688b3532/autohooks_plugin_ruff-24.1.0.tar.gz",
"platform": null,
"description": "\n\n# autohooks-plugin-ruff\n\n[](https://pypi.org/project/autohooks-plugin-ruff/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nformatting via [ruff](https://github.com/astral-sh/ruff).\n\n## Installation\n\n### Install using pip\n\n> [!NOTE] The `pip install` command does no longer work out-of-the-box in newer\n> distributions like Ubuntu >= 23.04 because of [PEP 668](https://peps.python.org/pep-0668).\n\nYou can install the latest stable release of autohooks-plugin-ruff from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n python3 -m pip install --user autohooks-plugin-ruff\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-ruff is\ninstalled as a development dependency.\n\n poetry add --group dev autohooks-plugin-ruff\n\n## Usage\n\nTo activate the ruff autohooks plugin please run\n\n```shell\npoetry run autohooks plugins add autohooks.plugins.ruff\n```\n \nor alternatively add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.ruff\"]\n```\n\nWhat the plugin actually does is `ruff check .` on git commit, so you should be\nable to use the exact same settings as in [ruff's docs](https://beta.ruff.rs/docs/settings/).\n\n## Notes\n\nThis project only runs ruff as a pre-commit hook, so, all features from ruff\nshould be available too.\n\nTo activate this pre-commit hook remember to run this command before you start:\n\n```shell\npoetry run autohooks activate --mode poetry\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-ruff/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-ruff/issues)\nfirst.\n\n## License\n\nCopyright (C) 2023 - 2024 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An autohooks plugin for python code formatting via ruff",
"version": "24.1.0",
"project_urls": {
"Homepage": "https://github.com/greenbone/autohooks-plugin-ruff",
"Repository": "https://github.com/greeenbone/autohooks-plugin-ruff"
},
"split_keywords": [
"git",
"formatting",
"linting",
"hooks",
"ruff"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2914453e200fc582aa7850de1307d92024a099bd7d8f3f728647cbee5baff8b7",
"md5": "191a4366ef1200579d2d203ce6232d8b",
"sha256": "2a072805b60abb63311abab84a6600cde9112840ab68f39af53f517648341651"
},
"downloads": -1,
"filename": "autohooks_plugin_ruff-24.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "191a4366ef1200579d2d203ce6232d8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 16371,
"upload_time": "2024-01-25T15:42:49",
"upload_time_iso_8601": "2024-01-25T15:42:49.058524Z",
"url": "https://files.pythonhosted.org/packages/29/14/453e200fc582aa7850de1307d92024a099bd7d8f3f728647cbee5baff8b7/autohooks_plugin_ruff-24.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0f69e32e22520393d3fe0d910b78ee84e738cfb27d5227613bb6a8d688b3532",
"md5": "ff72edb69639482a96fff8615666fe88",
"sha256": "1a8dd732a2e7215c1c66faa79ac499195859c499af7ce52284ee6003ece4f25c"
},
"downloads": -1,
"filename": "autohooks_plugin_ruff-24.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ff72edb69639482a96fff8615666fe88",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 33000,
"upload_time": "2024-01-25T15:42:50",
"upload_time_iso_8601": "2024-01-25T15:42:50.517780Z",
"url": "https://files.pythonhosted.org/packages/e0/f6/9e32e22520393d3fe0d910b78ee84e738cfb27d5227613bb6a8d688b3532/autohooks_plugin_ruff-24.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 15:42:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "autohooks-plugin-ruff",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autohooks-plugin-ruff"
}
JSON
