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 tool: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.1.0.tar.gz (7.2 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.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gommit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d68ac82a1388ea5082719fa44d5b567bd0e6920844b64f97402e6c5025036f61
MD5 05f4eb00b892b7d26bd81373b63e582f
BLAKE2b-256 05851bd2040c02da1292c26e12c1dbd72ec788889af17b346906d6919e11e1ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gommit-0.1.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 32f959098912fa4f98af8b6fc5d528d5be2cb81f13a860073875eed35639b17b
MD5 515ece052ab6a3a9127d472283d5b6e3
BLAKE2b-256 0024e6c17dd2c75b53ac08e010b2ba23f29bfd620ddcd3d68afc5c8e6925d695

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