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.1.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.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gommit-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 3aeffcda52ec8238cc7b38f725fb6852d698e14126efc6bcb1800eb3394ba9da
MD5 fd46b4f5e2d4820a76a85495bbacd3c0
BLAKE2b-256 8c217fc3ae38281cc617b19a54bc432e656d7666ba4c3c8f2398e9f17b53d655

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gommit-0.3.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7f85f33e10677aa70cef177f8e5a0897d84103b298c197f15f4d85b30f8ecb0c
MD5 6f3760d2a9dba90106014471c88fc047
BLAKE2b-256 baf42d47b7d5e29b87d8a298aae6deed4bc503c5a1bed6f871bb7d9832ba9b5f

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