gptcomet 0.0.3

gptcomet: A tool that leverages AI to automatically generate Git commit messages.

GPTComet: AI-Powered Git Commit Message Generator

Table of content

• GPTComet: AI-Powered Git Commit Message Generator
  • Table of content
  • Overview
  • Features
  • Installation
  • Usage
  • Commands
  • Configuration
  • Supported Keys
  • Example
  • Development
  • License
  • Contact

Overview

GPTComet is a Python library designed to automate the process of generating commit messages for Git repositories. It leverages the power of AI to create meaningful commit messages based on the changes made in the codebase.

Features

• Automatic Commit Message Generation: GPTComet can generate commit messages based on the changes made in the code.
• Support for Multiple Languages: GPTComet supports multiple languages, including English and Chinese.
• Customizable Configuration: GPTComet allows users to customize the configuration to suit their needs.
• Support for Rich Commit Messages: GPTComet supports rich commit messages, which include a title, summary, and detailed description.

Installation

To use GPTComet, you need to have Python installed on your system. You can install the library using pip:

pip install gptcomet

Recommend install use pipx on Mac or Linux.

pipx install gptcomet

After installing GPTComet, you will have two commands: gptcomet and gmsg.

Usage

To use gptcomet, follow these steps:

1. Install GPTComet: Install GPTComet through pypi.
2. Configure GPTComet: Configure GPTComet with your api_key The configuration file should contain the following keys:
   • provider: The provider of the language model (e.g., openai).
   • api_base: The base URL of the API (e.g., https://api.openai.com/v1).
   • api_key: The API key for the provider.
   • model: The model used for generating commit messages (e.g., gpt-3.5-turbo).
   • retries: The number of retries for the API request (e.g., 2).
3. Run GPTComet: Run GPTComet using the following command: gmsg generate commit.

Commands

The following are the available commands for GPTComet:

• gmsg config: Config manage commands group.
  • set: Set a configuration value.
  • get: Get a configuration value.
  • list: List all configuration values.
  • reset: Reset the configuration to its default values.
  • keys: List all supported keys.
  • append: Append a value to a configuration key. (List value only, like fileignore)
  • remove: Remove a value from a configuration key. (List value only, like fileignore)
• gmsg hook: Hook manage commands group(Prototype phase.).
  • install: Install the GPTComet hook.
  • uninstall: Uninstall the GPTComet hook.
  • status: Check the status of the GPTComet hook.
• gmsg gen: Generate messages by changes/diff.
  • commit: Generate a commit message based on the changes made in the code.
  • pr: Generate a pull request message based on the changes made in the code.

Configuration

The configuration file for GPTComet is gptcomet.toml. The file should contain the following keys:

• provider: The provider of the language model (e.g., openai).
• api_base: The base URL of the API (e.g., https://api.openai.com/v1).
• api_key: The API key for the provider.
• model: The model used for generating commit messages (e.g., gpt-3.5-turbo).
• retries: The number of retries for the API request (e.g., 2).
• prompt.brief_commit_message: The prompt for generating brief commit messages.
• prompt.translation: The prompt for translating commit messages to a target language.
• output.lang: The language of the commit message (e.g., en).

This project using litellm as the bridge to LLM providers, so plenty providers are supported.

Supported Keys

You can use gmsg config keys to check supported keys.

Example

Here is an example of how to use GPTComet:

1. When you first set your OpenAI KEY by gmsg config set openai.api_key YOUR_API_KEY, it will generate config file at ~/.local/gptcomet/gptcomet.toml, includes:

   provider = "openai"
   api_base = "https://api.openai.com/v1"
   api_key = "YOUR_API_KEY"
   model = "gpt-3.5-turbo"
   retries = 2
   output.lang = "en"
   

2. Run the following command to generate a commit message: gmsg generate commit
3. GPTComet will generate a commit message based on the changes made in the code and display it in the console.

Note: Replace YOUR_API_KEY with your actual API key for the provider.

Development

If you'd like to contribute to GPTComet, feel free to fork this project and submit a pull request.

First, fork the project and clone your repo.

git clone https://github.com/<yourname>/gptcomet

Second, make sure you have pdm, you can install by pip, brew or other way in their installation docs

Use just command install dependence, just is a handy way to save and run project-specific commands, just docs https://github.com/casey/just

just install

Or use pdm directly pdm install.

Then, you can submit a pull request.

License

GPTComet is licensed under the MIT License.

Contact

If you have any questions or suggestions, feel free to contact.