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

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.2.1.tar.gz (3.7 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.2.1-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-1.2.1.tar.gz
Algorithm Hash digest
SHA256 c724db13be1c341f6c9cfec44ddcd36417d705466520ad52e5e5d186590de412
MD5 a6e1a4cd5bc0ff52a0b8b7f0ed245fc5
BLAKE2b-256 149df21427262f59d0858094d468244cbfec8138f543630a8e43bad6cfc64903

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 68b7a16a480d1b89f09314f88a08abe26495faaf94ddb40df3883da46b54a1e6
MD5 3db7facd49e6f79e009226be5bfbcffb
BLAKE2b-256 39c6d92d12442a0bee0f2658ebbd4d3162213a966ee4d843b061b7855ff55d5b

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