gptcomet 0.0.2__tar.gz

gptcomet-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Belingud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gptcomet-0.0.2/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.1
+Name: gptcomet
+Version: 0.0.2
+Summary: gptcomet: A tool that leverages AI to automatically generate Git commit messages.
+Keywords: python
+Author-Email: belingud <im.victor@qq.com>
+License: MIT license
+Project-URL: Homepage, https://belingud.github.io/gptcomet/
+Project-URL: Repository, https://github.com/belingud/gptcomet
+Project-URL: Documentation, https://belingud.github.io/gptcomet/
+Requires-Python: <4.0,>=3.9
+Requires-Dist: gitpython>=3.1.43
+Requires-Dist: click>=8.1.7
+Requires-Dist: litellm>=1.43.0
+Requires-Dist: tomlkit>=0.13.0
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: orjson>=3.10.6
+Description-Content-Type: text/markdown
+
+# GPTComet: AI-Powered Git Commit Message Generator
+
+## Table of content
+
+<!-- TOC -->
+- [GPTComet: AI-Powered Git Commit Message Generator](#gptcomet-ai-powered-git-commit-message-generator)
+  - [Table of content](#table-of-content)
+  - [Overview](#overview)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [Commands](#commands)
+  - [Configuration](#configuration)
+  - [Supported Keys](#supported-keys)
+  - [Example](#example)
+  - [Development](#development)
+  - [License](#license)
+  - [Contact](#contact)
+<!-- TOC -->
+
+## 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:
+
+```shell
+pip install gptcomet
+```
+
+Recommend install use `pipx` on Mac or Linux.
+
+```shell
+pipx install gptcomet
+```
+
+
+## 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: `gptcomet generate commit`.
+
+## Commands
+
+The following are the available commands for GPTComet:
+
+* `gptcomet 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.
+* `gptcomet 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.
+* `gptcomet generate`: 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`).
+
+
+## Supported Keys
+
+You can use `gptcomet 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 `gptcomet 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: `GPTComet 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.
+
+## License
+
+GPTComet is licensed under the MIT License.
+
+## Contact
+
+If you have any questions or suggestions, feel free to contact.

gptcomet-0.0.2/README.md

@@ -0,0 +1,127 @@
+# GPTComet: AI-Powered Git Commit Message Generator
+
+## Table of content
+
+<!-- TOC -->
+- [GPTComet: AI-Powered Git Commit Message Generator](#gptcomet-ai-powered-git-commit-message-generator)
+  - [Table of content](#table-of-content)
+  - [Overview](#overview)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [Commands](#commands)
+  - [Configuration](#configuration)
+  - [Supported Keys](#supported-keys)
+  - [Example](#example)
+  - [Development](#development)
+  - [License](#license)
+  - [Contact](#contact)
+<!-- TOC -->
+
+## 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:
+
+```shell
+pip install gptcomet
+```
+
+Recommend install use `pipx` on Mac or Linux.
+
+```shell
+pipx install gptcomet
+```
+
+
+## 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: `gptcomet generate commit`.
+
+## Commands
+
+The following are the available commands for GPTComet:
+
+* `gptcomet 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.
+* `gptcomet 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.
+* `gptcomet generate`: 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`).
+
+
+## Supported Keys
+
+You can use `gptcomet 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 `gptcomet 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: `GPTComet 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.
+
+## License
+
+GPTComet is licensed under the MIT License.
+
+## Contact
+
+If you have any questions or suggestions, feel free to contact.

gptcomet-0.0.2/gptcomet/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "0.0.2"
+
+from gptcomet.cli import cli
+
+if __name__ == "__main__":
+    cli()

gptcomet-0.0.2/gptcomet/_types.py

@@ -0,0 +1,24 @@
+import typing as t
+
+import tomlkit
+
+# Config class types
+CacheKeys = t.Literal["default_config", "config"]
+
+
+class CacheType(t.TypedDict):
+    default_config: t.Optional[tomlkit.TOMLDocument]
+    config: t.Optional[tomlkit.TOMLDocument]
+
+
+class CompleteParams(t.TypedDict):
+    api_base: str
+    api_key: str
+    model: str
+    retries: int
+    messages: t.Union[list[dict], None, list]
+    max_tokens: t.Optional[int]
+    temperature: t.Optional[float]
+    top_p: t.Optional[float]
+    frequency_penalty: t.Optional[float]
+    extra_headers: t.Optional[dict]

gptcomet-0.0.2/gptcomet/cli.py

@@ -0,0 +1,300 @@
+import logging
+import sys
+
+import click
+from click import Context
+from git import InvalidGitRepositoryError, NoSuchPathError
+
+import gptcomet
+from gptcomet.config_manager import ConfigManager
+from gptcomet.exceptions import ConfigKeyError, GitNoStagedChanges, KeyNotFound
+from gptcomet.hook import AICommitHook
+from gptcomet.message_generator import MessageGenerator
+from gptcomet.utils import common_options
+
+logger = logging.getLogger(__name__)
+logging.basicConfig(
+    format="%(asctime)s [%(levelname)s] %(filename)s::%(funcName)s: %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+    level=logging.WARNING,
+)
+
+
+@click.group(
+    name="gptcomet",
+    help="AI-Powered Git Commit Message Generator",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+@click.pass_context
+@common_options
+@click.version_option(
+    gptcomet.__version__,
+    "--version",
+    "-v",
+    prog_name="gptcomet",
+    message="%(prog)s: %(version)s",
+)
+def cli(ctx: Context, debug, local):
+    """GPTComet CLI"""
+    if debug:
+        logger.setLevel(logging.DEBUG)
+    else:
+        logger.setLevel(logging.INFO)
+    logger.debug(f"Running with debug={debug}, local={local}")
+
+    ctx.obj["debug"] = debug
+    ctx.obj["local"] = local
+    ctx.obj["config_manager"] = None
+
+
+config: click.Group  # type hints for IDE
+
+@cli.group(name="config")
+@click.pass_context
+@common_options
+def config(ctx, debug, local):
+    """Manage gptcomet configuration."""
+    logger.debug(f"Config manage, local={local}")
+    if not ctx.obj["config_manager"]:
+        ctx.obj["config_manager"] = ConfigManager(ctx.obj["local"])
+
+
+@config.command("set", help="Set a configuration value.")
+@click.argument("key")
+@click.argument("value")
+@click.pass_context
+@common_options
+def config_set(ctx: Context, key, value, debug, local):
+    """Set a configuration value."""
+    try:
+        ctx.obj["config_manager"].set(key, value)
+        click.echo(
+            f"[GPTComet] Set {click.style(key, fg='green')} to {click.style(value, fg='green')}."
+        )
+    except ConfigKeyError as e:
+        click.echo(f"[GPTComet] Error: {e!s}")
+
+
+@config.command("get")
+@click.argument("key")
+@click.pass_context
+@common_options
+def config_get(ctx, key, debug, local):
+    """Get a configuration value."""
+    try:
+        value = ctx.obj["config_manager"].get(key)
+        click.echo(f"{key}: {value}")
+    except ValueError as e:
+        click.echo(f"Error: {e!s}")
+    except ConfigKeyError as e:
+        click.echo(str(e))
+
+
+@config.command("list")
+@click.pass_context
+@common_options
+def config_list(ctx: Context, debug, local):
+    """List all configuration values."""
+    click.echo(
+        click.style("Current configuration:\n", fg="green") + ctx.obj["config_manager"].list()
+    )
+
+
+@config.command("reset")
+@click.pass_context
+@common_options
+def reset(ctx: Context, debug, local):
+    """Reset configuration to default values."""
+    ctx.obj["config_manager"].reset()
+    click.echo("Configuration reset to default values")
+
+
+@config.command(name="keys")
+@click.pass_context
+@common_options
+def config_keys(ctx, debug, local):
+    cfg_manager: ConfigManager = ctx.obj["config_manager"]
+    keys = cfg_manager.list_keys()
+    click.echo(click.style("Supported keys:\n", fg="green") + keys)
+
+
+@config.command("path")
+@click.pass_context
+@common_options
+def config_path(ctx: Context, debug, local):
+    """Get the path to the configuration file."""
+    click.echo(
+        click.style("Current configuration path:\n", fg="green")
+        + ctx.obj["config_manager"].current_config_path.as_posix()
+    )
+
+
+hook: click.Group  # type hints for IDE
+
+
+@cli.group("hook", help="Manage GPTComet prepare-commit-msg hook.")
+@common_options
+@click.pass_context
+def hook(ctx: click.Context, debug, local):
+    pass
+
+
+@hook.command("install", help="Install GPTComet prepare-commit-msg hook to current repository.")
+@click.option(
+    "--force/--no-force",
+    "-f/-nf",
+    default=False,
+    help="Force installation or not.",
+    show_default=True,
+)
+@common_options
+@click.pass_context
+def install_hook(ctx, debug, local, force=False):
+    """Install GPTComet prepare-commit-msg hook."""
+    try:
+        comet_hook = AICommitHook()
+        if comet_hook.is_hook_installed() and not force:
+            click.echo(
+                "GPTComet prepare-commit-msg hook is already installed, use --force to force installation."
+            )
+            return
+        comet_hook.install_hook()
+        click.echo("GPTComet prepare-commit-msg hook has been installed successfully.")
+    except InvalidGitRepositoryError as e:
+        click.echo(f"Error: {e!s}")
+    except Exception as e:
+        click.echo(f"An error occurred while installing the hook: {e!s}")
+
+
+@hook.command("uninstall", help="Uninstall GPTComet prepare-commit-msg hook from current repository.")
+@common_options
+@click.pass_context
+def uninstall_hook(ctx: click.Context, debug, local, **kwargs):
+    """Uninstall GPTComet prepare-commit-msg hook."""
+    try:
+        comet_hook = AICommitHook()
+        comet_hook.uninstall_hook()
+    except (InvalidGitRepositoryError, NoSuchPathError) as e:
+        click.echo(f"Error: {e!s}")
+    except Exception as e:
+        click.echo(f"An error occurred while uninstalling the hook: {e!s}")
+
+
+@hook.command("status")
+def hook_status():
+    """Check if GPTComet prepare-commit-msg hook is installed."""
+    try:
+        comet_hook = AICommitHook()
+        if comet_hook.is_hook_installed():
+            click.echo("GPTComet prepare-commit-msg hook is installed.")
+        else:
+            click.echo(
+                f"GPTComet prepare-commit-msg hook is {click.style('not', fg='yellow')} installed."
+            )
+    except InvalidGitRepositoryError as e:
+        click.echo(f"Error: {e!s}")
+    except Exception as e:
+        click.echo(f"An error occurred while checking the hook status: {e!s}")
+
+
+generate: click.Group  # type hints for IDE
+
+
+@cli.group("generate", help="Generate a commit message based on `git diff --staged`.")
+@click.pass_context
+@common_options
+def generate(ctx: click.Context, debug, local):
+    ctx.obj["config_manager"] = ConfigManager(ctx.obj["local"])
+
+
+@generate.command("commit")
+# @click.option("--rich", is_flag=True, default=False, help="Generate rich commit message")
+@common_options
+@click.pass_context
+def generate_commit(ctx: click.Context, debug, local, rich=False, **kwargs):
+    """Generate a commit message based on git diff"""
+    click.echo(
+        click.style(
+            "🤖 Hang tight! I'm having a chat with the AI to craft your commit message...",
+            fg="green",
+        )
+    )
+    config_manager = ctx.obj["config_manager"]
+    message_generator = MessageGenerator(config_manager)
+    retry = True
+    commit_msg = None
+    while retry:
+        try:
+            commit_msg = message_generator.generate_commit_message(rich)
+        except KeyNotFound as e:
+            click.echo(f"Error: {e!s}, please check your configuration.")
+            raise click.Abort() from None
+        except GitNoStagedChanges as e:
+            click.echo(str(e))
+            raise click.Abort() from None
+
+        if commit_msg is None:
+            click.echo(click.style("No commit message generated.", fg="magenta"))
+            return
+
+        click.echo(click.style("Generated commit message:", fg="green"))
+        click.echo(commit_msg)
+
+        if sys.stdin.isatty():
+            # Interactive mode will ask for confirmation
+            char = click.prompt(
+                click.style(
+                    "Do you want to use this commit message? y: yes, n: no, r: retry.", fg="green"
+                ),
+                default="y",
+                type=click.Choice(["y", "n", "r"]),
+            )
+        else:
+            click.echo(
+                click.style(
+                    "Non-interactive mode detected, using the generated commit message directly.",
+                    fg="yellow",
+                )
+            )
+            char = "y"
+
+        if char == "n":
+            click.echo(click.style("Commit message discarded.", fg="yellow"))
+            return
+        elif char == "y":
+            retry = False
+        logger.debug(f"Input: {char}")
+        if char == "n":
+            click.echo(click.style("Commit message discarded.", fg="yellow"))
+            return
+        elif char == "y":
+            retry = False
+
+    message_generator.repo.index.commit(commit_msg)
+    click.echo(click.style("Commit message saved.", fg="green"))
+
+
+@click.command()
+@click.pass_context
+def generate_prmsg(ctx: click.Context, debug, local):
+    """Generate a pull request message based on changes compared to master"""
+    config_manager = ctx.obj["config_manager"]
+    message_generator = MessageGenerator(config_manager)
+
+    pr_msg = message_generator.generate_pr_message()
+
+    click.echo("Generated pull request message:")
+    click.echo(pr_msg)
+
+    if click.confirm("Do you want to use this pull request message?"):
+        # Here you could integrate with your Git hosting platform's API
+        # to create a pull request with this message
+        click.echo(
+            "Pull request message saved. You can now use it to create a PR on your Git hosting platform."
+        )
+    else:
+        click.echo("Pull request message discarded.")
+
+
+if __name__ == "__main__":
+    cli()