Skip to main content

Make your commit messages helpful, for once

Project description

Icon

Welcome to commitzilla! This is a simple git hook that will hijack your commit messages, and translate them into detailed, comprehensive messages, fit for anyone and everyone!

Example GIF

Installation

Installation is soooooo easy, just pip install the package:

pip install commitzilla

then navigate to the directory of your local git repo where you want to install the hook, and run:

commitzilla install

and bob's your uncle.

Configuration

You can change the character style of the commit message (or add your own custom one) by running:

commitzilla character

You can edit the OpenAI model (other providers coming soon) and the OpenAPI key with the configure command, for more info, run:

commitzilla configure

You can also enable a prefix, so your messages will look like this: [Character] Commit message so you can keep track of which commits are good and which are bad:

commitzilla prefix

Uninstallation

Not sure why you're reading this... but anyways, removing commitzilla is even easier than installing it, just navigate to the directory you want to remove the hook, and run:

commitzilla uninstall

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

commitzilla-0.2.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commitzilla-0.2.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file commitzilla-0.2.1.tar.gz.

File metadata

  • Download URL: commitzilla-0.2.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.9.20 Linux/6.5.0-1025-azure

File hashes

Hashes for commitzilla-0.2.1.tar.gz
Algorithm Hash digest
SHA256 981fb6c14d6415ae64559879b6e3293bb14316ab776ed24952d20e869a3a2774
MD5 c4ab6ba21ce06258d29babc76c2196c7
BLAKE2b-256 33252a7b99e94b342f1f23b44182a13b1b9904a3d967ba3548aca9d9031ed329

See more details on using hashes here.

File details

Details for the file commitzilla-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: commitzilla-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.9.20 Linux/6.5.0-1025-azure

File hashes

Hashes for commitzilla-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e7135b510416f3fbae64a85715cff3f2595f0ed02c356aa6910e8045e3af7b0
MD5 6fe83ceb49f361515da6eb1bf1b17797
BLAKE2b-256 7a20d759714d83ca54edb5e6ed39bca12f47e4b9d7464b83a72b154b1d15d858

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