Skip to main content

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 template. Want to automatically generate release notes? git tidy-log can be configured to group and render commits based on the schema.

Example

Documentation

View the git-tidy docs here for a complete tutorial on using git-tidy.

Installation

One can install git-tidy system-wide with 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 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)

Metadata

Release files for git-tidy 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for git-tidy 1.3.0
File Size Uploaded Provenance
git_tidy-1.3.0.tar.gz 14.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for git-tidy 1.3.0
File Interpreter ABI Platform
git_tidy-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 30.6 kB

Release files / git_tidy-1.3.0.tar.gz

Download URL git_tidy-1.3.0.tar.gz
Size 14.8 kB
Tags Source
SHA-256 checksum
How to use checksums
789fe2ce8e0e6a650c19362d8eab910cc5053de633b415e7b4f349fe0aff0ee4
BLAKE2b-256 checksum
How to use checksums
65f018c94b6074211debd678197e7f07e1f70212c89ca1ef27314bce53e6bb30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/5.15.0-1057-aws

Release files / git_tidy-1.3.0-py3-none-any.whl

Download URL git_tidy-1.3.0-py3-none-any.whl
Size 15.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0669fa36efd40566e6b297dfb228b101cf280e496e9eaee3062b966274b295c1
BLAKE2b-256 checksum
How to use checksums
405a78490a7dc408ded3c873195f0aaa444c7d5663b7dab3d0203368b1f2ef85
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/5.15.0-1057-aws

Security for git-tidy 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page