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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.2.5.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.5.tar.gz
Algorithm Hash digest
SHA256 ae0ee2f8996a3def14b939339f82e2d12d3d9480072f0cedffaf73d9ef65c558
MD5 53a831b6a35258a9e5d68630fdd71561
BLAKE2b-256 35f681e061ef6e42a27b7f962d7bb3e498f682343fddd70b639244fe1321c5c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 83caffa399825465ee0ec9d2bdebcd3a71b5e107b9156c6438f5254d567cbe5c
MD5 5e40d17047c084115dbda244e1091a2e
BLAKE2b-256 2a3cc2dc8fc9464d54fcc331f43e9c2abdcad807f777a44e05b5267e77002338

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