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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.4.1.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.1.tar.gz
Algorithm Hash digest
SHA256 91bd1234a58825505a83f938fd79b1a98f4790174c2eb789c7e9aa017fe8dc03
MD5 6642f59f12903fabcb9519968196fc31
BLAKE2b-256 dc8c4ce323c1e4cc99324c577fb20ded85a432e78c167f05837890eac263e63c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f362bd1c3ccab0a304bce7eb2e3c398b0ec97db52360ede51efbc93668f80e7
MD5 e40a6d424000146558b0b5f3f19c421e
BLAKE2b-256 b0836b08c7da2dc55ce9690673f66f4a30a62abd3d11d1bbf6daa79fe3dd791f

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