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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gommit-0.4.0.tar.gz
Algorithm Hash digest
SHA256 02facacc0cb35f6a64ce2a809050b3590fb7c2a52dba5c13cd68ffbeab1930a6
MD5 7a7374f229acfbdafef42b03af076a9b
BLAKE2b-256 2f14703235c3f6e2cf823666bfbe68230201d49c07aa01d3a4d5a37aa4ef81bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gommit-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4ef17ebcb422d2eabaae6a4dc40c9c7062c28a533d4ea154effc6f0261b5f63
MD5 839da37a550b441349ec1ad85f749129
BLAKE2b-256 e2dc40e83067c9039e5ae29ad132d196262e391850772c1d920f57b23eaadef2

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