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
  • 🤖 Choose your preferred OpenAI model (gpt-4o-mini, gpt-4o, etc.)

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 (watadarkstar)

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.7.2.tar.gz
  • Upload date:
  • Size: 4.4 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.2.tar.gz
Algorithm Hash digest
SHA256 6ef2a987e31e57dbf6affb4b44f3cc1395a29204d91aef3a1cb989e48a6a9473
MD5 79d0a5c9a88085869de703bff970a019
BLAKE2b-256 6b37fe8640425ba3f881a14c79e5e94222c649db242a34f4087323ad4b5274c2

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cz_ai-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 4.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9909a6df485bf42c6d9d7006528c2c1867cd945bf14598b1adc6664f50e95292
MD5 df32bfe6d0987b9bd64409b61cc00e34
BLAKE2b-256 49daea2478724e5a7678ec4027d7359141b6840f53dbea71c2b5532302acee24

See more details on using hashes here.

Provenance

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