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.3.0.tar.gz (4.3 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.3.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.3.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for cz_ai-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b7c8833c80ee0983ab27850fd2d31d3c5819df22d14c8a3c2f700e33b655a392
MD5 ad871ec8b61aa812fb1b55130b423476
BLAKE2b-256 ea8fff988440bb932d237feccaea2bff366674d69ea4a64fcfd0597cd7ab42f6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for cz_ai-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb569ebb0ecfe1772be25114cbca4c2968ebac6a125ee360d579393c87b45647
MD5 1a8347890cd7bdba8a4afc36ee21d06d
BLAKE2b-256 c305735b034a43db28cdd46160f151a8c909b3061323d15298380f1577664f52

See more details on using hashes here.

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