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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.2.0.tar.gz
  • Upload date:
  • Size: 3.6 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.0.tar.gz
Algorithm Hash digest
SHA256 68d0a916b1dd2ed979c6c6422c135e4ab1172d440915510e18a7716a7c2ed767
MD5 a0dc3a161d3f0fb22ca5061261127e93
BLAKE2b-256 f05a352a53193c7721383e903281614016cba8ef2b7d6e1c4f5775a6d4d60293

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e77c5c2e428ade7a77248b5124c23c78c81753d19d9f4f6ba25a862c6c15005e
MD5 a767e044a04ff9c6e43fc6b6fda9d887
BLAKE2b-256 588e21e55430a55d821e496a1fc4241d88ec55309ffab2ed9b3fc50b47373a6a

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