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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.5.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.5.0.tar.gz
Algorithm Hash digest
SHA256 8609488296b1771ba44e21a0e5551c77bdf5ad94678b3c44dbf4fb6bf050f5ba
MD5 fff097be565316e7e2ee68120f6047d0
BLAKE2b-256 4788cc9dd503f8b8fa4da7382e32d9a2cce6a522294a4ec89127cc2d54d4bbe1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f57f85212407461291c1bbcc99518da9cca2e3b922040669cc403aec31aba25d
MD5 3e0fb3d25bf2c1cba3095c83b6017ad6
BLAKE2b-256 ca70281c74dda6612a8eaac458abc09fce651066ece0b1872a2a33caacf507f7

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