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

🚀 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.5.0.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.5.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.5.0.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.5.0.tar.gz
Algorithm Hash digest
SHA256 14dc1c2d266458a432e2457fa0924a5bccdac9e5491c92e25fa74098a7ade1ca
MD5 8805c515b93e963d371724b6737aa9b9
BLAKE2b-256 e77dc05b3a9eb20a4ae54936060feb01cdd3b7f59a3ea8ecd28180b42a4286b5

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cz_ai-0.5.0-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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cdb8b4b8cecd5f9ab1d31b9ca4c8a41d845ebe0a04e3b923732d01dded2a95ab
MD5 93ebf17ee45f51a8d8be827c64ceab36
BLAKE2b-256 a9a6c15730090bd918d71d26752df04f2c85ee934a75a4535e9ea01c0f1114ad

See more details on using hashes here.

Provenance

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