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.1.3.tar.gz (3.2 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.1.3-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for commitmessagegenerator-1.1.3.tar.gz
Algorithm Hash digest
SHA256 5e6f6a521cb11662c1db0bb1db05b833894e298070db89d69f649f9f8fd067ea
MD5 96afdb8a05874a7cc1b73c67572f8498
BLAKE2b-256 dff14c0912ae78ee5feb5c4cb6069e9ea59d19678df7ca1799f997656799deda

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for commitmessagegenerator-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 985dc51272a29e96f83f1fba7678f29dfcc5f0d4e3dfd8229cf381d12fc3a534
MD5 477add313a53400af759db983d51e66b
BLAKE2b-256 3ed4b03e364e70dbedcb3d8065f970abfa8f97de8538a625b66dd51e3cbf2973

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