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.1.2.tar.gz (3.3 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.2-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.1.2.tar.gz
  • Upload date:
  • Size: 3.3 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.2.tar.gz
Algorithm Hash digest
SHA256 ecf087acfd7a493f1e97c0471ebea6b939cfd25ea55c85656c10b299b693f25e
MD5 65ce7402d54875c808ae5e74624305dc
BLAKE2b-256 6bfdc09a71c3c38a7c92004e2f714004749dd8fa6ecb6a255b8a1d4b2a1be80f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 15a4fec71b58d61e9ba04e156a27ed3c2c5fd1fb901d0d8cbd137ee4e1217b52
MD5 12ba1874c6e6bc32ec971c9a37ae15b0
BLAKE2b-256 e7eb1df2311ca9cabf424fa74b4d88798686c5821517608bd51c1fe4190bdaa5

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