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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cz_ai-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 ace8cd8cbf1450f38b71d1ccef543fbde90357873b741ed71190253d223588dd
MD5 9813596c5aacd21d2a200e4f10e8dfeb
BLAKE2b-256 d07474add10599de300833878e5a85a8cc05a406c7bd69a1c9e371819a10eb0c

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: cz_ai-0.7.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7c4dbf18e2c676bc22c3d86ee8151ab898e2c81a5b9e08c45671ba76c3fd388
MD5 f4d565763f9e2a99e41d70964b06956d
BLAKE2b-256 851984ab1a7d8aa6325a4df4722b2a16d589e814b51e047d52febfa3c191fa66

See more details on using hashes here.

Provenance

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