commitizen

library4.18.0pypypi✓ verified 28d ago

Commitizen is a Python client tool that standardizes commit messages, automates version bumping using Semantic Versioning, and generates changelogs. It helps development teams maintain consistent commit history and streamline release processes. The library is actively maintained with frequent patch releases, and the current version is 4.13.9.

devops workflow

pip install commitizen

github ↗package ↗docs ↗changelog ↗

INSTALL

IMPORT

SIG · COMMITIZEN

commitizen

devopspythonv4.18.0

Install

4.1s avg

Import

—

Disk

34MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v4.18.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 · 36.6MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 4.1s · import 0.000s · 38MB

34MB installed

● package 34MB

Code

Verified usage

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

Commitizen CLI

✓ cz init cz commit cz bump

Commitizen is primarily a command-line interface (CLI) tool. Direct programmatic Python imports for end-user commit or bump functionality are not the standard usage pattern. The commands shown are for invoking the CLI.

To get started, initialize Commitizen in your project, which guides you through creating a configuration file (e.g., in `pyproject.toml` or `.cz.toml`). Then, use `cz commit` for an interactive prompt to create conventional commits, and `cz bump` to automatically increment your project's version and update the changelog based on these commits.

# 1. Initialize Commitizen in your Git repository (creates a .cz.toml or modifies pyproject.toml) cz init # 2. Use 'cz commit' instead of 'git commit' for guided, conventional commits cz commit # 3. Automatically bump version and generate changelog based on conventional commits cz bump --changelog # Example pyproject.toml configuration # [tool.commitizen] # name = "cz_conventional_commits" # version = "0.1.0" # tag_format = "v$version" # version_files = [ # "pyproject.toml:version", # "src/__init__.py:__version__" # ] # update_changelog_on_bump = true

cz --version

Debug

Known issues

breakingPython 3.6 is no longer officially supported as of Commitizen v4.x. Users on older Python versions must upgrade their environment to Python 3.7 or greater (current minimum is 3.10).

fix

Upgrade your Python environment to 3.10 or newer.

affects: >=4.0.0

breakingFor developers creating custom plugins, the way plugins are exposed changed in v4.x. They are now exposed as `commitizen.plugin` entrypoints.

fix

Update custom plugins to use the `commitizen.plugin` entrypoint mechanism.

affects: >=4.0.0

deprecatedThe `cz bump --files-only` CLI flag was deprecated in version 4.13.0 and has been replaced by `--version-files-only`.

fix

Replace `--files-only` with `--version-files-only` in your `cz bump` commands.

affects: >=4.13.0

gotchaWhen using `cz bump` in CI/CD pipelines, it might fail if there are no conventional commits eligible for a version bump (e.g., only 'chore' commits). This triggers a `NoneIncrementExit` (exit code 21).

fix

Use the `--no-raise` flag or specifically ignore exit code 21 (`cz --no-raise NO_INCREMENT bump`) to allow the command to succeed without a version bump when no changes qualify.

affects: All

gotchaIf you need to pass Git-specific flags like `-s` (signoff) to `git commit` when using `cz commit`, you must use a double dash (`--`) to separate Commitizen's arguments from Git's. For example, `cz commit -- -s` is correct, while `cz commit -s` is deprecated and will not work as expected.

fix

Prefix Git-specific arguments with `--`, e.g., `cz commit -- -s`.

affects: All

Upgrade

Version history

4.18.0latest on PyPI · released Aug 19, 2026

Audit

Dependencies

pythonrequiredRequired Python interpreter version for the library.

Agent activity

21 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/commitizen-tools/commitizen ↗

packagehttps://pypi.org/project/commitizen/ ↗

docshttps://commitizen-tools.github.io/commitizen/ ↗

changeloghttps://github.com/commitizen-tools/commitizen/blob/master/CHANGELOG.md ↗