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.3.0.tar.gz (7.6 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.3.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gommit-0.3.0.tar.gz
Algorithm Hash digest
SHA256 507c03b9663e8b24253d006110d921a6dcd571be593a037c2ba76b5542fc0791
MD5 ce2c02ed503130a7fcb5a77025d64adc
BLAKE2b-256 b480d007c2bfd2ccbd8c4dd70fbf28642bdfe634f48653689c9cbe65d2976d80

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gommit-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.1 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c893a8e58d4fcfac2f3a959800bb97082f1e892ed687de0a7563171ef0523353
MD5 7c4f65c5955a6f03f59777eec481d89e
BLAKE2b-256 dadb017dbdf8ba4b8d24aee942e81e99f95415ad833ba0f6fc14dcf3ad73dbfd

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