{"id":18565046,"url":"https://github.com/greenbone/autohooks-plugin-ruff","last_synced_at":"2025-04-10T04:32:17.490Z","repository":{"id":175768047,"uuid":"651503701","full_name":"greenbone/autohooks-plugin-ruff","owner":"greenbone","description":"An autohooks plugin for linting via ruff","archived":false,"fork":false,"pushed_at":"2024-04-15T06:21:12.000Z","size":332,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-17T16:11:16.442Z","etag":null,"topics":["automation","base","devops","hooks","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenbone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-06-09T11:35:46.000Z","updated_at":"2024-04-22T05:38:46.237Z","dependencies_parsed_at":null,"dependency_job_id":"ebc36dcf-eec7-4b42-ba08-59f9a527b48a","html_url":"https://github.com/greenbone/autohooks-plugin-ruff","commit_stats":null,"previous_names":["greenbone/autohooks-plugin-ruff"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fautohooks-plugin-ruff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fautohooks-plugin-ruff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fautohooks-plugin-ruff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fautohooks-plugin-ruff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenbone","download_url":"https://codeload.github.com/greenbone/autohooks-plugin-ruff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223424313,"owners_count":17142745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","base","devops","hooks","python"],"created_at":"2024-11-06T22:17:30.290Z","updated_at":"2025-04-10T04:32:17.478Z","avatar_url":"https://github.com/greenbone.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# autohooks-plugin-ruff\n\n[![PyPI release](https://img.shields.io/pypi/v/autohooks-plugin-ruff.svg)](https://pypi.org/project/autohooks-plugin-ruff/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nlinting and formatting via [ruff](https://github.com/astral-sh/ruff).\n\n## Installation\n\n### Install using pip\n\n\u003e [!NOTE] The `pip install` command does no longer work out-of-the-box in newer\n\u003e distributions like Ubuntu \u003e= 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```sh\npython3 -m pip install --user autohooks-plugin-ruff\n```\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```sh\npoetry add --group dev autohooks-plugin-ruff\n```\n\n## Usage\n\nTo activate the ruff autohooks plugin for linting please run\n\n```shell\npoetry run autohooks plugins add autohooks.plugins.ruff.check\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.check\"]\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\nTo activate the ruff autohooks plugin for code formatting please run\n\n```shell\npoetry run autohooks plugins add autohooks.plugins.ruff.format\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.format\"]\n```\n\nWhat the plugin actually does is `ruff format .` 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 - 2025 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fautohooks-plugin-ruff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenbone%2Fautohooks-plugin-ruff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fautohooks-plugin-ruff/lists"}