Skip to main content

Generate commit messages with AI (Google Gemini) automatically using `git diff`.

Project description

commitmessagegenerator

Generate objective and technical commit messages with AI (Google Gemini) automatically using your git diff.

📦 Install

pip install commitmessagegenerator

Or, if you're using a venv:

python -m venv venv
source venv/bin/activate  # or .\venv\Scripts\activate in Windows
pip install commitmessagegenerator

⚙️ Configuring

IMPORTANT - BEFORE CREATING THIS FILE ADD '.venv' TO YOUR .gitignore SO YOUR API KEY ISN'T EXPOSED

Create a .env file in the directory where you will run commitgen (usually the root of your Git project):

GEMINI_API_KEY=your-gemini-api-key

🚀 Usage

With the terminal, inside any Git repository with pending changes, run:

commitgen (-c/-cg)

The command will:

  • Read the git diff;
  • Send it to the Google Gemini API;
  • Return a commit message suggestion directly in your terminal.

🧩 Requisites

  • Python 3.8 or higher
  • Gemini API Key (Google Generative AI, free at: https://aistudio.google.com/app/apikey)
  • Initialized Git repository
  • Python dependencies (Automatically installed with the package):
    • GitPython
    • google-generativeai
    • python-dotenv

📄 License

MIT License

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

commitmessagegenerator-1.2.3.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commitmessagegenerator-1.2.3-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file commitmessagegenerator-1.2.3.tar.gz.

File metadata

  • Download URL: commitmessagegenerator-1.2.3.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for commitmessagegenerator-1.2.3.tar.gz
Algorithm Hash digest
SHA256 50de2ac32182bca04e1b02539ebc2ca34704b026c04100f0c5c5883fe6b8c2d0
MD5 2fff885021eb8a8d36e4474c35b4c253
BLAKE2b-256 24b4db07f6d36be4d3b9026cb6b79ee01d8ba540ce42ddd9a1c17c8f613606fe

See more details on using hashes here.

File details

Details for the file commitmessagegenerator-1.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f7f6386dc73960943d1339b5a00fcea214d684bcdec8a16c073de58f26fdab1c
MD5 d4661f2e99f91dea04b9bbc0ffa3063f
BLAKE2b-256 7368b176a32b0ba963d2a5cdbd522c682c53d39de6c27b70d6929e011971e657

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