# 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.8 - 3.12.
## 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.8.0",
"maintainer_email": null,
"keywords": null,
"author": "Wes Kendall",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b3/e8/1784bc34fde5de53c056d8eca1efaa1feb13e6d903a39f1965fbd6579705/git_tidy-1.2.1.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.8 - 3.12.\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.2.1",
"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": "6782c07b2ef88b1d7178c0153491ad2695b364f067305c4077ab3821979ef1a5",
"md5": "b500267904e9cb2b8ac8ed5d0c2ab812",
"sha256": "8beb0e3bd112c5fff5febed9531ded57480866ebfa7f052aea87afe9ea4f672d"
},
"downloads": -1,
"filename": "git_tidy-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b500267904e9cb2b8ac8ed5d0c2ab812",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8.0",
"size": 15819,
"upload_time": "2024-04-23T21:18:58",
"upload_time_iso_8601": "2024-04-23T21:18:58.295371Z",
"url": "https://files.pythonhosted.org/packages/67/82/c07b2ef88b1d7178c0153491ad2695b364f067305c4077ab3821979ef1a5/git_tidy-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3e81784bc34fde5de53c056d8eca1efaa1feb13e6d903a39f1965fbd6579705",
"md5": "b1363cb184d50c4f7c593113d231f045",
"sha256": "7c62055ccca320d38be81da792be093cc4266aded8a13e269c33066cbe841ea6"
},
"downloads": -1,
"filename": "git_tidy-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "b1363cb184d50c4f7c593113d231f045",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8.0",
"size": 14758,
"upload_time": "2024-04-23T21:18:59",
"upload_time_iso_8601": "2024-04-23T21:18:59.893690Z",
"url": "https://files.pythonhosted.org/packages/b3/e8/1784bc34fde5de53c056d8eca1efaa1feb13e6d903a39f1965fbd6579705/git_tidy-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 21:18:59",
"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
