description for the cz
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
Install the plugin:
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cz_ai-0.2.0.tar.gz.
File metadata
- Download URL: cz_ai-0.2.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e762b05f56bf9bc80931bf19dbfac34d879e99335aed9a21896103f633942b46
|
|
| MD5 |
ddf8f7fc043c118c235a87d331733fef
|
|
| BLAKE2b-256 |
4671d6031354c7f3b51090fab0e8f335dc6579c808e359f7d9f91f628980968c
|
File details
Details for the file cz_ai-0.2.0-py3-none-any.whl.
File metadata
- Download URL: cz_ai-0.2.0-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0c100cbc9ae62885785cb3d4f7f8d2b68a9d5f3d1507902982797e35c5239b96
|
|
| MD5 |
5cbe74ec95b2f9a61982772b267a7d4a
|
|
| BLAKE2b-256 |
90a1540b7cac7ccc1c45a4db377a6e75419915c67578c58328b06cda114aa90f
|