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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 3931c88095a37af94956904aeb519689c88bb24c03ba4fd63c40462b530d19b9
MD5 6940574238ce4da9890ea72132f43e5d
BLAKE2b-256 b55d4d60803506b3d19e95936dc09d5efebb51e9f5604c67d30fcc80fc7d536d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c4d0ac6aa152234b9f5b0d732b2ddf37fa9ef8decfd099685bca1549be62d3e
MD5 98cb1b7c0d34d251bac539ed1eae9a0b
BLAKE2b-256 9277dfd170adcd78174f81eea220bba5aa1ae9ab0e40973c18ea923615bd002c

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