| Name | pre-commit-tool JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | Very simple human-friendlier wrapper around pre-commit |
| upload_time | 2024-11-17 03:34:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 jmknoble Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cli
git
pre-commit
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pre-commit-tool
A simple wrapper around some [pre-commit][] commands that remembers some needed arguments for you,
and that provides some abbreviations and friendly aliases.
[begintoc]: #
## Contents
- [Commands](#commands)
- [Installation](#installation)
- [Contributing](#contributing)
[endtoc]: # (Generated by mark-toc pre-commit hook)
## Commands
| Command | Description |
|----------|----------------------------------------------------------------|
| help | Print help |
| install | Install pre-commit hooks using `pre-commit install-hooks ...` |
| run | Run pre-commit hooks using `pre-commit run-hooks ...` |
| sync | Sync and garbage-collect pre-commit hooks |
| update | Update pre-commit hooks using `pre-commit autoupdate ...` |
| upgrade | Alias for `update` |
| use | "Use" (install) the pre-commit tool with `uv tool install ...` |
| validate | Validate the pre-commit config file |
Any command can be given with or without a leading `--` (that is, `--help` is the same as `help`).
Most commands take additional arguments that get passed on to `pre-commit`.
Most commands require a '.pre-commit-config.yaml' to be present.
## Installation
Use your favorite way of installing Python packages. It's really easy with [uv][uv-install]):
uv tool install pre-commit-tool
uvx pre-commit-tool help
You can also add this package as a development dependency to a `uv`-managed project:
uv add --dev pre-commit-tool
uv run pre-commit-tool help
## Contributing
See [DEVELOPING](DEVELOPING.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "pre-commit-tool",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cli, git, pre-commit",
"author": null,
"author_email": "jmknoble <jmknoble@pobox.com>",
"download_url": "https://files.pythonhosted.org/packages/40/1f/a88a330f3f13acf649a67586dd44d9039f47177657ed808ad4cee292cb12/pre_commit_tool-0.1.8.tar.gz",
"platform": null,
"description": "# pre-commit-tool\n\nA simple wrapper around some [pre-commit][] commands that remembers some needed arguments for you,\nand that provides some abbreviations and friendly aliases.\n\n[begintoc]: #\n\n## Contents\n\n- [Commands](#commands)\n- [Installation](#installation)\n- [Contributing](#contributing)\n\n[endtoc]: # (Generated by mark-toc pre-commit hook)\n\n\n## Commands\n\n| Command | Description |\n|----------|----------------------------------------------------------------|\n| help | Print help |\n| install | Install pre-commit hooks using `pre-commit install-hooks ...` |\n| run | Run pre-commit hooks using `pre-commit run-hooks ...` |\n| sync | Sync and garbage-collect pre-commit hooks |\n| update | Update pre-commit hooks using `pre-commit autoupdate ...` |\n| upgrade | Alias for `update` |\n| use | \"Use\" (install) the pre-commit tool with `uv tool install ...` |\n| validate | Validate the pre-commit config file |\n\nAny command can be given with or without a leading `--` (that is, `--help` is the same as `help`).\n\nMost commands take additional arguments that get passed on to `pre-commit`.\n\nMost commands require a '.pre-commit-config.yaml' to be present.\n\n\n## Installation\n\nUse your favorite way of installing Python packages. It's really easy with [uv][uv-install]):\n\n uv tool install pre-commit-tool\n uvx pre-commit-tool help\n\nYou can also add this package as a development dependency to a `uv`-managed project:\n\n uv add --dev pre-commit-tool\n uv run pre-commit-tool help\n\n\n## Contributing\n\nSee [DEVELOPING](DEVELOPING.md).\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 jmknoble Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Very simple human-friendlier wrapper around pre-commit",
"version": "0.1.8",
"project_urls": {
"Repository": "https://github.com/jmknoble/pre-commit-tool"
},
"split_keywords": [
"cli",
" git",
" pre-commit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f68ab66d9c88de5e6df6c9fa6c0265f6e095e7a7e08f5c05a221aebc7d626d41",
"md5": "0c401d2d114af1f5ad8d1e72ebe8e655",
"sha256": "78ac43d27ce6890059682ab4dd0ee92752cd9af41d9529d94bf68d7145c6f437"
},
"downloads": -1,
"filename": "pre_commit_tool-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c401d2d114af1f5ad8d1e72ebe8e655",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6673,
"upload_time": "2024-11-17T03:34:01",
"upload_time_iso_8601": "2024-11-17T03:34:01.669029Z",
"url": "https://files.pythonhosted.org/packages/f6/8a/b66d9c88de5e6df6c9fa6c0265f6e095e7a7e08f5c05a221aebc7d626d41/pre_commit_tool-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "401fa88a330f3f13acf649a67586dd44d9039f47177657ed808ad4cee292cb12",
"md5": "01c40ecc79a9bf090bf564c6eb43c14c",
"sha256": "b0e05ec8a82e4b54612ca312632d99209c622964f26869be40081fb3c960c760"
},
"downloads": -1,
"filename": "pre_commit_tool-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "01c40ecc79a9bf090bf564c6eb43c14c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11068,
"upload_time": "2024-11-17T03:34:03",
"upload_time_iso_8601": "2024-11-17T03:34:03.328095Z",
"url": "https://files.pythonhosted.org/packages/40/1f/a88a330f3f13acf649a67586dd44d9039f47177657ed808ad4cee292cb12/pre_commit_tool-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 03:34:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmknoble",
"github_project": "pre-commit-tool",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pre-commit-tool"
}
