Skip to main content

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

Usage

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


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.1.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.1.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.1.0.tar.gz
  • Upload date:
  • Size: 4.2 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.1.0.tar.gz
Algorithm Hash digest
SHA256 fdd2a30204fd1e4b5acde3cec21d1d6b71164b4691210b5f4ad38f597a921a19
MD5 ea0c1ec7ac0925dda176e3c6159b1cb2
BLAKE2b-256 991655b0a06da819b97b105de6d5ac0d21a0cadf4a41c9a9a6ebc838d5575606

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cz_ai-0.1.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

Hashes for cz_ai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f18f37ab80e92303bd903625abebaf35904ab7bad5eba29794ebc05863be2e3c
MD5 d92c7fe49e85dc3fed375fa32499ac48
BLAKE2b-256 e79132eec7d420409e9ac381944d612dbe3269b4ef6d2818910c73459b72d939

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