Skip to main content

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

Reason this release was yanked:

failed when running

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.1.1.tar.gz (3.2 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.1.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-1.1.1.tar.gz
Algorithm Hash digest
SHA256 199d77d10d5a8e4c2f6a32dd7b922bd489f42115d0c4e9af40ba14a7fd6d205c
MD5 1a86810b432c02973d3d25bf2beccb9f
BLAKE2b-256 45eaa69eca8f2650ce4b7aba70eaee8df3cf740255e89c350e48b26942749631

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f67e1cb9b3d8ce41052ff76efcbe06a680f0ed0436684e8d79b9a0f5a3f1835f
MD5 9aee7364063d3333d613538e0c43a53a
BLAKE2b-256 ab7ae2e4cd2c3d863a6f2268b5fa12d6febe3c1a7dbe16a73ba8d34e748905cc

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