<p align="center">
<em>Library for managing and writing git hooks in Python using `pyproject.toml` for its settings ✨</em>
</p>
## Installation
You can add commitguard in a few easy steps. First of all, install the dependency:
```shell
$ pip install commitguard
---> 100%
Successfully installed commitguard-0.1.0
```
or Using poetry
```shell
poetry add --dev commitguard
poetry run commitguard activate --mode poetry
```
The output of `commitguard activate` should be similar to:
```shell
✓ commitguard pre-commit hook installed at /commitguard/.git/hooks/pre-commit using poetry mode.
```
CommitGuard offers an adaptable plugin architecture where each plugin offers unique features that might require the installation of supplementary dependencies.
To manage these dependencies, CommitGuard presently supports three modes:
* `pythonpath` for dependency management via [pip]
* `poetry` for dependency management via [poetry] (recommended)
* `pipenv` for dependency management via [pipenv]
These modes dictate how CommitGuard, the plugins, and their dependencies are loaded during git hook execution.
## License
This project is licensed under the terms of the MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/yezz123/CommitGuard",
"name": "commitguard",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.2,<4.0.0",
"maintainer_email": "",
"keywords": "git,formatting,linting,hooks",
"author": "Yasser Tahiri",
"author_email": "hello@yezz.me",
"download_url": "https://files.pythonhosted.org/packages/9a/df/5354733bc42ad61048c785038dd9419ed566a1c023f2909cd58111cf50ec/commitguard-2.2.0.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <em>Library for managing and writing git hooks in Python using `pyproject.toml` for its settings \u2728</em>\n</p>\n\n## Installation\n\nYou can add commitguard in a few easy steps. First of all, install the dependency:\n\n```shell\n$ pip install commitguard\n\n---> 100%\n\nSuccessfully installed commitguard-0.1.0\n```\n\nor Using poetry\n\n```shell\npoetry add --dev commitguard\npoetry run commitguard activate --mode poetry\n```\n\nThe output of `commitguard activate` should be similar to:\n\n```shell\n \u2713 commitguard pre-commit hook installed at /commitguard/.git/hooks/pre-commit using poetry mode.\n```\n\nCommitGuard offers an adaptable plugin architecture where each plugin offers unique features that might require the installation of supplementary dependencies.\n\nTo manage these dependencies, CommitGuard presently supports three modes:\n\n\n* `pythonpath` for dependency management via [pip]\n* `poetry` for dependency management via [poetry] (recommended)\n* `pipenv` for dependency management via [pipenv]\n\nThese modes dictate how CommitGuard, the plugins, and their dependencies are loaded during git hook execution.\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for managing and writing git hooks in Python using pyproject.toml for its settings \u2728",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/yezz123/CommitGuard",
"Repository": "https://github.com/yezz123/CommitGuard"
},
"split_keywords": [
"git",
"formatting",
"linting",
"hooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "044d2467e7d3c00b05f5d314afdd1891c3743e98f106c3894e4734b4dc4cbebb",
"md5": "9b323c7be3e140e3b3814f35cc319b02",
"sha256": "304d9353e443bd0bc016463034ab488aca93dde09da53fef41f4d654e552abaf"
},
"downloads": -1,
"filename": "commitguard-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b323c7be3e140e3b3814f35cc319b02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.2,<4.0.0",
"size": 27261,
"upload_time": "2023-05-15T13:29:42",
"upload_time_iso_8601": "2023-05-15T13:29:42.893284Z",
"url": "https://files.pythonhosted.org/packages/04/4d/2467e7d3c00b05f5d314afdd1891c3743e98f106c3894e4734b4dc4cbebb/commitguard-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9adf5354733bc42ad61048c785038dd9419ed566a1c023f2909cd58111cf50ec",
"md5": "ef35672d1cbea6d623e174fa687fc349",
"sha256": "0050ba4d9341be3e5f073df2bd27ad4367325af29b49e01f2c76bf3bcbc5ae8a"
},
"downloads": -1,
"filename": "commitguard-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ef35672d1cbea6d623e174fa687fc349",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.2,<4.0.0",
"size": 49039,
"upload_time": "2023-05-15T13:29:44",
"upload_time_iso_8601": "2023-05-15T13:29:44.735723Z",
"url": "https://files.pythonhosted.org/packages/9a/df/5354733bc42ad61048c785038dd9419ed566a1c023f2909cd58111cf50ec/commitguard-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-15 13:29:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yezz123",
"github_project": "CommitGuard",
"github_not_found": true,
"lcname": "commitguard"
}
JSON
