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.0.0.tar.gz (3.1 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.0.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6a5dd2679532ed9a248343ba82658efea3a04e3d5c48e0a58b735a0b5de14ed7
MD5 b3616448fc6067fa5595922df5ef76a6
BLAKE2b-256 edce11f350f755b5dd10b85645dc33da14197b6fb3019248091f3adfd4911905

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e52d7ead60a21a0a0ec3d114f512e5e8b2d2ea64dddefe56412ad0aaf195944
MD5 b9f4d0aaeacee50bdf82bd0688ca8cd5
BLAKE2b-256 ebdd2cf8147dc2fec64a12144623e79874c0f36e87e85b362dfbd4a6bd457e17

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