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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 cf4b42542a4738502a8279e39592eede2445f9ed74a2be1763bec245d8a63019
MD5 be8d9e0586b37452b59d8809c42f05ae
BLAKE2b-256 c5d84f5fe97513e8897fdfa3776d621f891144f6f77fbf5440977cda08c174e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 df7104c05e8371103816c41498d9e5b527d51d637620bc5ec3c3ecb79ad08cdc
MD5 ab5cd2bbe9d40c87f85fb8211ca4a128
BLAKE2b-256 33079f42369b54583a2eaf62f5d2868210e642900d0700da29edcb3a6e4cc025

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