Skip to main content

A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.

Project description

🤖 AI Commitizen Plugin

A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.

✨ Features

  • 🔍 Analyzes your staged diffs using OpenAI GPT-4o
  • 🧠 Generates commit messages that follow the Conventional Commits specification
  • 💬 Suggests high-quality messages instantly to save time
  • 🛠️ Seamlessly integrates with existing Commitizen workflows

🚀 Ideal For

  • Developers who want to maintain a consistent and meaningful commit history
  • Teams adopting conventional commits without manual formatting
  • Projects aiming for automated changelog generation and semantic versioning

Install

pip install cz-ai

Usage

cz --name cz_ai commit

Development

Install the plugin locally:

pip install -e .

Then check that cz recognizes the plugin:

cz ls

It should appear as cz_ai

Then run this command to test it:

cz commit

Build

python3 -m build

Upload to pypi.org

twine upload dist/*

Author

Adrian C (author@commitizen)

Credits

Generated using this template: https://github.com/commitizen-tools/commitizen_cz_template

📄 License

This project is licensed under the MIT License.
Feel free to use, modify, and distribute it as needed.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cz_ai-0.4.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cz_ai-0.4.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file cz_ai-0.4.0.tar.gz.

File metadata

  • Download URL: cz_ai-0.4.0.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cz_ai-0.4.0.tar.gz
Algorithm Hash digest
SHA256 4f004c224ef64affd5e91fe081933d61d7b685c2d9bb3e0969144f3391197cdf
MD5 85b752a65b68853a4817e1e7c6773fc2
BLAKE2b-256 4621b9f1f1bc6ba1af2fab97816b6e3473fc3f7da9b4a0c36c2044608a5598c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_ai-0.4.0.tar.gz:

Publisher: ci.yml on watadarkstar/cz_ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cz_ai-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: cz_ai-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cz_ai-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0dc32f930f6fba7b9b5da1ac319464a8e0502b1b687635c4227fb90e2d2c7644
MD5 d6a29da1b6721e2999553fac6ed221a1
BLAKE2b-256 4d3820ce12e29ad96fd2c236decfb521c71fc7892fe0c6c2b91987de4fb3d79c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_ai-0.4.0-py3-none-any.whl:

Publisher: ci.yml on watadarkstar/cz_ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page