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

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-0.1.5.tar.gz
Algorithm Hash digest
SHA256 48bcfbe17f54cb5eef61b4346348e33d6b3d177c68f36cde95eaad6c2120ff52
MD5 ed362a9443da6dfc235f386e24855b44
BLAKE2b-256 1d28b149d0becce2b7159e889592dbce796b6c089b8899259b3cf80669263d76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 571cd6f0eb4ced745ae364487dd63d93c3bc23be81ab4959718fd8f58129e31c
MD5 eaad166d2d5987109db464381413b7f5
BLAKE2b-256 56b2e8b26d905512a0ec53fab37bf743cc66edd0ee7cd9d78a3d51d5d96beb66

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