commit-check

library2.8.0pypypi✓ verified 81d ago

A Python library and CLI tool to enforce commit message formatting, branch naming conventions, author/email checks, and other git-related validations. Version 2.6.0 targets Python >=3.9 and is released periodically.

devops

pip install commit-check

github ↗package ↗

INSTALL

IMPORT

SIG · COMMIT-CHECK

commit-check

devopspythonv2.8.0

Install

1.8s avg

Import

—

Disk

19MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.8.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 20.3MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.8s · import 0.000s · 21MB

19MB installed

● package 19MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

version

✓ from commit_check import version

✗ from commit_check import CommitCheck

DEFAULT_COMMIT_TYPES

✓ from commit_check import DEFAULT_COMMIT_TYPES

✗ from commit_check import CommitCheck

DEFAULT_BRANCH_NAMES

✓ from commit_check import DEFAULT_BRANCH_NAMES

✗ from commit_check import CommitCheck

Basic usage of commit-check programmatically. For CLI: run `commit-check` in terminal.

from commit_check import CommitCheck checker = CommitCheck(project_root='.', config={}) results = checker.run() for result in results: print(result.passed, result.message)

commit-check --version

Debug

Known issues

breakingIn v2.0.0, the Config class was moved from top-level to commit_check.config module. Direct imports from commit_check.Config will fail.

fix

Change 'from commit_check import Config' to 'from commit_check.config import Config'

affects: >=2.0.0

deprecatedThe 'debug' parameter in CommitCheck constructor is deprecated since v2.5.0 and will be removed in v3.0.0. Use 'log_level' instead.

fix

Replace debug=True with log_level='DEBUG'

affects: 2.5.0+

gotchaInstallation creates a 'commit-check' command but it may conflict with other tools named 'commit-check' installed via npm or as a shell alias. Use 'python -m commit_check' as fallback.

fix

Use 'python -m commit_check' if CLI command is shadowed.

affects: all

gotchaThe library expects to be run inside a git repository. Calling CommitCheck.run() outside a git repo raises GitCommandError.

fix

Wrap in try/except or check for .git directory before calling.

affects: all

Upgrade

Version history

2.8.0latest on PyPI · released Jun 13, 2026

Audit

Dependencies

gitpythonrequiredRequired for git operations and repository access

richrequiredRequired for colorful CLI output and progress display

clickrequiredRequired for CLI interface

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/commit-check/commit-check ↗

packagehttps://pypi.org/project/commit-check/ ↗