Metadata-Version: 2.1
Name: git-tidy
Version: 1.2.1
Summary: Tidy git commit messages, linting, and logging
Home-page: https://github.com/Opus10/git-tidy
License: BSD-3-Clause
Author: Wes Kendall
Requires-Python: >=3.8.0,<4
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: click (>7.0)
Requires-Dist: formaldict (>0.2.0)
Requires-Dist: jinja2 (>2.10.3)
Requires-Dist: packaging (>20.0)
Requires-Dist: python-dateutil (>2.8.1)
Requires-Dist: pyyaml (>=5.1.2,<=5.3.1)
Requires-Dist: requests (>2.22.0)
Project-URL: Documentation, https://git-tidy.readthedocs.io
Project-URL: Repository, https://github.com/Opus10/git-tidy
Description-Content-Type: text/markdown

# 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.

![Example](https://raw.githubusercontent.com/jyveapp/git-tidy/main/docs/static/tidy-commit.gif)

## 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)

