Skip to main content

Generate Git commit messages using an OpenAI-compatible API

Project description

Git Commit AI A Python tool to generate Git commit messages for staged changes using an OpenAI-compatible API. Installation From PyPI:

pip install gommit

Requirements

  • Python 3.6
  • Git installed and accessible in PATH
  • OpenAI API key set as an environment variable (OPENAI_API_KEY)

Environment Variables Set the following environment variables in your ~/.bashrc or ~/.zshrc for persistence:

export OPENAI_API_KEY=your-api-key-here
export OPENAI_BASE_URL=https://api.openai.com/v1  # Optional, defaults to OpenAI API
export OPENAI_MODEL=gpt-4o-mini                   # Optional, defaults to gpt-4o-mini

Add them and reload your shell:

echo 'export OPENAI_API_KEY=your-api-key-here' >> ~/.bashrc
echo 'export OPENAI_BASE_URL=https://api.openai.com/v1' >> ~/.bashrc
echo 'export OPENAI_MODEL=gpt-4o-mini' >> ~/.bashrc
source ~/.bashrc

Usage

Stage your changes in a Git repository:git add .

Run the gommit

Review the generated commit message and choose to commit (y) or abort (n).

Notes

  • The script uses git diff --cached to read only staged changes.
  • Customize the API endpoint or model via OPENAI_BASE_URL and OPENAI_MODEL environment variables.
  • Ensure your Git repository is properly initialized before running.

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

gommit-0.2.0.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.

gommit-0.2.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file gommit-0.2.0.tar.gz.

File metadata

  • Download URL: gommit-0.2.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for gommit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cf3170752e63b6dfb5d8bd6071109faacc47d613a1af5e40cbf5df070d44087c
MD5 644584ff1d4308aaaa94e75b2b9bf9ea
BLAKE2b-256 7f3a7a3190f9f545844c0c4f8cd5651617b24feaea3a54a195554c05729b68fb

See more details on using hashes here.

File details

Details for the file gommit-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gommit-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for gommit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aec052f47b8a55f1d1c4e04bf5424f0a8bb0867ad7fb9788aa8f87f75b7ce0fa
MD5 fce1c01034c257f8a2147b89aac89fd4
BLAKE2b-256 1bf26cfec59034e983a8a6c1a49a2307cbe40b967f8f50af74a89ebd32f3a575

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