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

commitgen -cf

Run this and type you API key to the terminal so the package creates the .env file and automatically adds it to the .gitignore

Or do it manually:

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/-cp)

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-1.4.0.tar.gz
Algorithm Hash digest
SHA256 25e89a79284ed91811d6886f8d27ba5ff0b710b21db91ccfa320af8aa5522442
MD5 d5b114c4441ad774068ed877cc414fb3
BLAKE2b-256 5633249dec0ee9e3872cf0e0233626d08daf74ba86dea02e9ccbca94afdd36ba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 121ecb69294fa27c254229a5c2ce6fb1ed6f9040f62802a8317d7017526b092f
MD5 e630b1abbcd769d0d0752b1d4efe1a80
BLAKE2b-256 a843d389f491c2aafc690dfa928d748ba5ab1cdffd80c0ad3e835b33f8dc1a57

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