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

PyPI

🤖 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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.7.0.tar.gz
  • Upload date:
  • Size: 4.3 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.7.0.tar.gz
Algorithm Hash digest
SHA256 caf791499ea56e114743027160ac7f669a74b20bf288971a12a72252d2e38f8e
MD5 e7c9b4b6b49a8b6df33c27b22e750be0
BLAKE2b-256 c6f7bb81f5642ac9fa0d65d08444e88be690acb2f9927d24926fcf23a97ccc1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_ai-0.7.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.7.0-py3-none-any.whl.

File metadata

  • Download URL: cz_ai-0.7.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c8b3d24d927d78aae29412f9bd9c7d04bf4b24ee57d5b335a0e3227c1471247
MD5 97e78a2e1d3bf3d19f25303b4c543c3c
BLAKE2b-256 517ed376754c917b8e6ebf73b32e2a2040f16251cfd36120d90a76542902f19c

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_ai-0.7.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