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

Uploaded Python 3

File details

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

File metadata

  • Download URL: commitmessagegenerator-1.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 e4c4bc5b018745459cd3f899c2e8f2353c62873c4e3dfd036a42fe9f7cc3f713
MD5 bd22101b39701a9d6a6eb6d3bcc4baa0
BLAKE2b-256 31aa303cc1687e6bff8e5dd4d16a9a5039c1d8d1991309204e1d201f4a57b125

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 05cb97a4e5612312d69ca031dee98642d26d2708e2cfc669b2a0dc08531ce169
MD5 15fd9ba5ebe650c6842ebbb3048e6e95
BLAKE2b-256 6ea7bbd35fa9e0ccae78a40121f221d5ac64d45c551b7aadbbd9afb8423f475e

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