# git-tidy
`git-tidy` is a set of git extensions for:
1. Keeping your git logs tidy with ease. `git tidy-commit` guides users through a structured commit with a configurable schema. `git tidy-squash` squashes messy commits into one tidy commit.
2. Linting a commit log. `git tidy-lint` verifies that commits match the schema. If a user uses `git tidy-commit`, commits will *always* validate.
3. Rendering a commit log. `git tidy-log` can render commits from any range and can render structured commits from a configurable [Jinja](https://jinja.palletsprojects.com/en/2.11.x/) template. Want to automatically generate release notes? `git tidy-log` can be configured to group and render commits based on the schema.
## Documentation
[View the git-tidy docs here](https://git-tidy.readthedocs.io/) for a complete tutorial on using `git-tidy`.
## Installation
One can install `git-tidy` system-wide with [pipx](https://github.com/pipxproject/pipx):
pipx install git-tidy
or pip:
pip3 install git-tidy
**Note** `git-tidy` depends on git at a version of 2.22 or higher. OSX users can upgrade to the latest `git` version with [homebrew](brew.sh) using `brew install git`.
## Compatibility
`git-tidy` is compatible with Python 3.9 - 3.13.
## Contributing Guide
For information on setting up git-tidy for development and contributing changes, view `CONTRIBUTING.rst <CONTRIBUTING.rst>`_.
## Creators
- @wesleykendall (Wes Kendall)
- @tomage (Tómas Árni Jónasson)
Raw data
{
"_id": null,
"home_page": "https://github.com/Opus10/git-tidy",
"name": "git-tidy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "Wes Kendall",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/65/f0/18c94b6074211debd678197e7f07e1f70212c89ca1ef27314bce53e6bb30/git_tidy-1.3.0.tar.gz",
"platform": null,
"description": "# git-tidy\n\n`git-tidy` is a set of git extensions for:\n\n1. Keeping your git logs tidy with ease. `git tidy-commit` guides users through a structured commit with a configurable schema. `git tidy-squash` squashes messy commits into one tidy commit.\n2. Linting a commit log. `git tidy-lint` verifies that commits match the schema. If a user uses `git tidy-commit`, commits will *always* validate.\n3. Rendering a commit log. `git tidy-log` can render commits from any range and can render structured commits from a configurable [Jinja](https://jinja.palletsprojects.com/en/2.11.x/) template. Want to automatically generate release notes? `git tidy-log` can be configured to group and render commits based on the schema.\n\n\n\n## Documentation\n\n[View the git-tidy docs here](https://git-tidy.readthedocs.io/) for a complete tutorial on using `git-tidy`.\n\n## Installation\n\nOne can install `git-tidy` system-wide with [pipx](https://github.com/pipxproject/pipx):\n\n pipx install git-tidy\n\nor pip:\n\n pip3 install git-tidy\n\n**Note** `git-tidy` depends on git at a version of 2.22 or higher. OSX users can upgrade to the latest `git` version with [homebrew](brew.sh) using `brew install git`.\n\n## Compatibility\n\n`git-tidy` is compatible with Python 3.9 - 3.13.\n\n## Contributing Guide\n\nFor information on setting up git-tidy for development and contributing changes, view `CONTRIBUTING.rst <CONTRIBUTING.rst>`_.\n\n## Creators\n\n- @wesleykendall (Wes Kendall)\n- @tomage (T\u00f3mas \u00c1rni J\u00f3nasson)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Tidy git commit messages, linting, and logging",
"version": "1.3.0",
"project_urls": {
"Documentation": "https://git-tidy.readthedocs.io",
"Homepage": "https://github.com/Opus10/git-tidy",
"Repository": "https://github.com/Opus10/git-tidy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "405a78490a7dc408ded3c873195f0aaa444c7d5663b7dab3d0203368b1f2ef85",
"md5": "5657c86c2edf5d4df579374c9db5a4bf",
"sha256": "0669fa36efd40566e6b297dfb228b101cf280e496e9eaee3062b966274b295c1"
},
"downloads": -1,
"filename": "git_tidy-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5657c86c2edf5d4df579374c9db5a4bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9.0",
"size": 15819,
"upload_time": "2024-11-02T20:00:32",
"upload_time_iso_8601": "2024-11-02T20:00:32.817060Z",
"url": "https://files.pythonhosted.org/packages/40/5a/78490a7dc408ded3c873195f0aaa444c7d5663b7dab3d0203368b1f2ef85/git_tidy-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65f018c94b6074211debd678197e7f07e1f70212c89ca1ef27314bce53e6bb30",
"md5": "865ae06214c02ac4943b673ad17be631",
"sha256": "789fe2ce8e0e6a650c19362d8eab910cc5053de633b415e7b4f349fe0aff0ee4"
},
"downloads": -1,
"filename": "git_tidy-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "865ae06214c02ac4943b673ad17be631",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9.0",
"size": 14772,
"upload_time": "2024-11-02T20:00:34",
"upload_time_iso_8601": "2024-11-02T20:00:34.288042Z",
"url": "https://files.pythonhosted.org/packages/65/f0/18c94b6074211debd678197e7f07e1f70212c89ca1ef27314bce53e6bb30/git_tidy-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 20:00:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Opus10",
"github_project": "git-tidy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "git-tidy"
}
JSON
