commitai 0.1.14__py3-none-any.whl → 0.1.16__py3-none-any.whl

commitai/cli.py

@@ -15,6 +15,11 @@ from commitai.git import (
     save_commit_template,
     stage_all_changes,
 )
+from commitai.template import (
+    adding_template,
+    build_user_message,
+    default_system_message,
+)
 
 
 @click.group(context_settings=dict(help_option_names=["-h", "--help"]))
@@ -22,8 +27,8 @@ def cli():
     pass
 
 
-@cli.command()
-@click.argument("description_or_command", nargs=-1, type=click.UNPROCESSED)
+@cli.command(name="generate")
+@click.argument("description", nargs=-1, type=click.UNPROCESSED)
 @click.option(
     "--commit",
     "-c",
@@ -48,93 +53,134 @@ def cli():
     default="claude-opus",
     help="Set the engine model to be used",
 )
-def main(description_or_command, commit, template, add, model):
-
-    description_or_command_exists = len(description_or_command) > 1
-    is_command = (
-        description_or_command[0] == "create-template"
-        if description_or_command_exists
-        else False
-    )
-
-    if is_command:
-        if len(description_or_command) > 1:
-            template_content = " ".join(description_or_command[1:])
-            save_commit_template(template_content)
-            click.echo("Template saved successfully.")
-            return
-        else:
-            click.echo("Please provide the template content.")
-        return
-
-    explanation = " ".join(description_or_command)
+def generate_message(description, commit, template, add, model):
+    explanation = " ".join(description)
     if model == "gpt-4":
         llm = ChatOpenAI(model_name="gpt-4")
     elif model == "claude-opus":
         llm = ChatAnthropic(model="claude-3-opus-20240229")
     else:
-        click.echo(f"Unsupported model: {model}")
+        click.secho(f"🚫 Unsupported model: {model}", fg="red", bold=True)
         return
 
     if add:
         stage_all_changes()
 
+    click.secho(
+        "\n🔍 Looking for a native pre-commit hook and running it\n",
+        fg="blue",
+        bold=True,
+    )
+
     if not run_pre_commit_hook():
-        click.echo("Pre-commit hook failed. Aborting commit.")
+        click.secho(
+            "🚫 Pre-commit hook failed. Aborting commit.",
+            fg="red",
+            bold=True,
+        )
         return
 
     diff = get_staged_changes_diff()
     if not diff:
-        click.echo("Warning: No staged changes found. Exiting.")
+        click.secho(
+            "⚠️ Warning: No staged changes found. Exiting.",
+            fg="yellow",
+            bold=True,
+        )
         return
 
+    # Clear the terminal using click
+    click.clear()
+
     repo_name = get_repository_name()
     branch_name = get_current_branch_name()
     formatted_diff = f"{repo_name}/{branch_name}\n\n{diff}"
 
     if not template:
         template = get_commit_template()
-
-    system_message = (
-        "You are a helpful git commit assistant. "
-        "You will receive a git diff and generate a commit message."
-        "Try to be meaningful and avoid generic messages."
-    )
+    system_message: str = ""
     if template:
-        system_message += "The message should follow this template: "
+        system_message += default_system_message
+        system_message += adding_template
         system_message += template
 
-    user_message = formatted_diff
     if explanation:
-        user_message = (
-            f"Here is a high-level explanation of the commit: "
-            f"{explanation}\n\n{user_message}"
-        )
-
-    input_message = f"{system_message}\n\n{user_message}"
-    click.echo("\n\nGenerating commit message...\n\n")
-
+        diff = build_user_message(explanation, formatted_diff)
+
+    input_message = f"{system_message}\n\n{diff}"
+    click.secho(
+        "\n\n🧠 Analyzing the changes and generating a commit message...\n\n",
+        fg="blue",
+        bold=True,
+    ),
     ai_message = llm.invoke(input=input_message)
     commit_message = ai_message.content
 
-    if commit:
-        create_commit(commit_message)
-        click.echo(f"Committed message:\n\n{commit_message}")
+    repo_path = get_repository_name()
+    commit_msg_path = os.path.join(repo_path, ".git", "COMMIT_EDITMSG")
+    with open(commit_msg_path, "w") as f:
+        f.write(commit_message)
+
+    if not commit:
+        click.edit(filename=commit_msg_path)
+
+    with open(commit_msg_path, "r") as f:
+        final_commit_message = f.read().strip()
+
+    create_commit(final_commit_message)
+    click.secho(
+        f"\n\n✅ Committed message:\n\n{final_commit_message}\n\n",
+        fg="green",
+        bold=True,
+    )
+
+
+@cli.command(name="create-template")
+@click.argument("template_content", nargs=-1, type=click.UNPROCESSED)
+def create_template_command(template_content):
+    template_content = " ".join(template_content)
+    if template_content:
+        save_commit_template(template_content)
+        click.secho("📝 Template saved successfully.", fg="green")
     else:
-        repo_path = get_repository_name()
-        commit_msg_path = os.path.join(repo_path, ".git", "COMMIT_EDITMSG")
-        # Open default git editor for editing the commit message
-        with open(commit_msg_path, "w") as f:
-            f.write(commit_message)
-        click.edit(filename=".git/COMMIT_EDITMSG")
-
-        # Read the edited commit message
-        with open(commit_msg_path, "r") as f:
-            edited_commit_message = f.read().strip()
-
-        # Create the commit with the edited message
-        create_commit(edited_commit_message)
-        click.echo(f"Committed message:\n\n{edited_commit_message}")
+        click.secho("❗ Please provide the template content.", fg="red")
+
+
+@click.command(name="commitai")
+@click.argument("description", nargs=-1, type=click.UNPROCESSED)
+@click.option(
+    "--add",
+    "-a",
+    is_flag=True,
+    help="Stage all changes before generating the commit message",
+)
+@click.option(
+    "--commit",
+    "-c",
+    is_flag=True,
+    help="Commit the changes with the generated message",
+)
+@click.pass_context
+def commitai(ctx, description, add, commit):
+    if add:
+        stage_all_changes()
+    ctx.invoke(
+        generate_message,
+        description=description,
+        add=add,
+        commit=commit,
+    )
+
+
+@click.command(name="commitai-create-template")
+@click.argument("template_content", nargs=-1, type=click.UNPROCESSED)
+@click.pass_context
+def commitai_create_template(ctx, template_content):
+    ctx.invoke(create_template_command, template_content=template_content)
+
+
+cli.add_command(commitai)
+cli.add_command(commitai_create_template)
 
 
 if __name__ == "__main__":

commitai/template.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+# flake8: noqa: E501
+
+default_system_message = (
+    "You are a helpful git commit assistant. "
+    "You will receive a git diff and generate a clear, concise, and meaningful commit message."
+    "The commit message should strictly follow the conventional commit format: "
+    "<type>(<scope>): <subject>\n\n<body>\n\n<footer>"
+    "Types can be: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert."
+    "Scope is optional and represents the section of the codebase affected by the changes."
+    "Subject should be a short summary of the changes, in present tense and imperative mood."
+    "Body should provide more details about the changes, if necessary."
+    "Footer can contain references to issues, pull requests, or breaking changes."
+    "Avoid generic messages like 'update', 'fix bugs', or 'improve code'."
+    "Focus on the specific changes made and their impact."
+)
+
+adding_template = " The message should follow this template: "
+
+
+def build_user_message(explanation, diff):
+    return (
+        f"Here is a high-level explanation of the commit: {explanation}" f"\n\n{diff}"
+    )

commitai-0.1.16.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.1
+Name: commitai
+Version: 0.1.16
+Summary: Commitai helps you generate git commit messages using AI
+Home-page: https://github.com/lguibr/commitai
+Author: Luis Guilherme
+Author-email: lgpelin92@gmail.com
+Project-URL: Bug Tracker, https://github.com/lguibr/commitai/issues
+Project-URL: Documentation, https://github.com/lguibr/commitai/blob/main/README.md
+Project-URL: Source Code, https://github.com/lguibr/commitai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: langchain
+Requires-Dist: click
+Requires-Dist: langchain-community
+Requires-Dist: langchain-anthropic
+Requires-Dist: langchain-openai
+Requires-Dist: setuptools
+
+# CommitAi - Your AI-Powered Commit Assistant
+
+[![CI](https://github.com/lguibr/commitai/workflows/CI/badge.svg)](https://github.com/lguibr/commitai/actions)
+[![codecov](https://codecov.io/gh/lguibr/commitai/graph/badge.svg?token=MXZKCXO6LA)](https://codecov.io/gh/lguibr/commitai)
+[![PyPI](https://img.shields.io/pypi/v/CommitAi.svg)](https://pypi.org/project/CommitAi/)
+[![Python Version](https://img.shields.io/pypi/pyversions/CommitAi.svg)](https://pypi.org/project/CommitAi/)
+[![License](https://img.shields.io/pypi/l/CommitAi.svg)](https://github.com/lguibr/CommitAi/blob/main/LICENSE)
+
+**CommitAi** simplifies the Git commit message creation process by leveraging AI technologies, including GPT-4 and Claude. Designed for developers who value clarity and precision in commit histories, **CommitAi** offers a streamlined workflow that transforms your staged changes and high-level explanations into informative commit messages. Enhance your project documentation and streamline your development process with commit messages that truly reflect your changes.
+
+## Demo
+
+![CommitAi Demo](./assets/commitaai.gif)
+
+This demo GIF shows CommitAi in action, demonstrating how it generates a commit without any additional input, using Claude 3 Opus.
+
+## Features
+
+- **Intelligent Commit Generation**: Leverages state-of-the-art AI models to generate meaningful commit messages from your changes.
+- **Pre-commit Checks**: Automatically runs configured pre-commit hooks to ensure quality and consistency before generating messages.
+- **Template Support**: Utilizes both global and repository-specific commit message templates to maintain a consistent style across your projects.
+- **AI Model Integration**: Supports multiple AI models, including GPT-4 by OpenAI and Claude by Anthropic, ensuring versatility in natural language processing capabilities.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.6 or later
+- API keys for GPT-4 and Claude, as required
+
+### Installation
+
+Install **CommitAi** directly from PyPI:
+
+```bash
+pip install commitai
+```
+
+### Configuration
+
+#### API Keys
+
+Set the necessary API keys as environment variables:
+
+```bash
+export OPENAI_API_KEY="your_openai_api_key"
+export ANTHROPIC_API_KEY="your_anthropic_api_key"
+```
+
+#### Commit Templates
+
+Set a global commit template environment variable:
+
+```bash
+export TEMPLATE_COMMIT="My global custom template: {message}"
+```
+
+Or, create a repository-specific template using:
+
+```bash
+commitai-create-template "My repository-specific template: {message}"
+```
+
+This creates a hidden template file within the `.git` directory of your repository.
+
+## Usage
+
+To generate a commit message, provide a high-level explanation of your changes:
+
+```bash
+commitai "This is a high-level explanation of my commit"
+```
+
+#### Options
+
+- `-a, --add`: Stage all changes before generating the commit message.
+- `-c, --commit`: Automatically create the commit using the generated message.
+- `-t, --template`: Specify a commit template. Defaults to the global template if available.
+- `-m, --model`: Choose the AI model (`gpt-4` by default).
+
+### Additional Commands
+
+- `commitai-create-template`: Set a custom template specific to your repository.
+
+## Contributing
+
+Contributions are welcome! Feel free to fork the repository, push your changes to a branch, and open a pull request. For bugs, questions, or feature requests, please open an issue through the GitHub issue tracker.
+
+## License
+
+**CommitAi** is open-source software licensed under the MIT License. See the [LICENSE](https://github.com/lguibr/CommitAi/blob/main/LICENSE) file for more details.

commitai-0.1.16.dist-info/RECORD

@@ -0,0 +1,9 @@
+commitai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+commitai/cli.py,sha256=e6AxBnTBRW4yjl8lmzYBYWaVDdpZQ97UV3k81IvjLzY,4766
+commitai/git.py,sha256=XWAloZWQuLrFHUyfh3SkOgLsL4kfKRtgj3fzuJjcL2A,1649
+commitai/template.py,sha256=KlAhYUgea1rXpih6TyFeZ2rU8qN1H-VfZpMt7Wi8dZA,1137
+commitai-0.1.16.dist-info/METADATA,sha256=b4NT4tsnKlVFoyH3SrJyjeHG2ctwJdms7H9ngh2xvvM,4711
+commitai-0.1.16.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+commitai-0.1.16.dist-info/entry_points.txt,sha256=KS-RBWo8XGrU1a11k6FgRCIwjGq8X5Zs-OuY8ri9BYU,116
+commitai-0.1.16.dist-info/top_level.txt,sha256=X76OfoBOic7IkaMkIgobuZxsVlsmcY_WMtBrtXtfn_w,9
+commitai-0.1.16.dist-info/RECORD,,

{commitai-0.1.14.dist-info → commitai-0.1.16.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

commitai-0.1.16.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+commitai = commitai.cli:commitai
+commitai-create-template = commitai.cli:commitai_create_template

commitai-0.1.14.dist-info/METADATA

@@ -1,100 +0,0 @@
-Metadata-Version: 2.1
-Name: commitai
-Version: 0.1.14
-Summary: Commitai helps you generate git commit messages using AI
-Home-page: https://github.com/lguibr/commitai
-Author: Luis Guilherme
-Author-email: lgpelin92@gmail.com
-License: UNKNOWN
-Project-URL: Bug Tracker, https://github.com/lguibr/commitai/issues
-Project-URL: Documentation, https://github.com/lguibr/commitai/blob/main/README.md
-Project-URL: Source Code, https://github.com/lguibr/commitai
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: click
-Requires-Dist: langchain
-Requires-Dist: langchain-anthropic
-Requires-Dist: langchain-community
-Requires-Dist: langchain-openai
-Requires-Dist: setuptools
-
-# CommitAi - Commit Message AI
-
-[![CI](https://github.com/lguibr/commitai/workflows/CI/badge.svg)](https://github.com/lguibr/commitai/actions)
-[![PyPI](https://img.shields.io/pypi/v/CommitAi.svg)](https://pypi.org/project/CommitAi/)
-[![Python Version](https://img.shields.io/pypi/pyversions/CommitAi.svg)](https://pypi.org/project/CommitAi/)
-[![License](https://img.shields.io/pypi/l/CommitAi.svg)](https://github.com/lguibr/CommitAi/blob/main/LICENSE)
-
-commitai is a command-line tool that helps you generate informative and relevant commit messages for your Git repositories using AI language models like GPT-4 and Claude. It analyzes your staged changes, combines them with a high-level explanation provided by you, and creates a commit message based on this information. Additionally, it supports custom commit message templates. This not only saves you time and effort but also ensures a consistent and meaningful commit history.
-
-## Features
-
-- Automatically runs the repository's pre-commit hook (if it exists) before generating the commit message to avoid discarded commit costs.
-- Generates informative and relevant commit messages based on staged changes and user-provided explanations.
-- Supports custom commit message templates.
-- Integrates with AI language models like GPT-4 and Claude for intelligent commit message generation.
-
-## Prerequisites
-
-- Python 3.x
-- API keys for the desired language models (e.g., OpenAI API key for GPT-4, Anthropic API key for Claude)
-
-## Installation
-
-You can install commitai using pip:
-
-pip install commitai
-
-## Configuration
-
-### Environment Variables
-
-Before using commitai, you need to set the API key environment variables for the language models you want to use. For example:
-
-export OPENAI_API_KEY="your_openai_api_key"
-export ANTHROPIC_API_KEY="your_anthropic_api_key"
-
-You can also set the `TEMPLATE_COMMIT` environment variable to define a global template for your commit messages:
-
-export TEMPLATE_COMMIT="My global custom template: {message}"
-
-### Template Configuration
-
-#### Creating a Template for the Repository
-
-You can create a custom template specific to the repository using the `create-template` command. This template will override the global template set in the `TEMPLATE_COMMIT` environment variable if present.
-
-commitai create-template "My repository-specific template: {message}"
-
-This command will create a hidden file inside the `.git` directory to store the template.
-
-## Usage
-
-### Generating Commit Messages
-
-commitai generate "This is a high-level explanation of my commit"
-
-- Use the `-a` or `--add` flag to stage all changes.
-- Use the `-c` or `--commit` flag to automatically create the commit.
-- Use the `-t` or `--template` flag for custom templates or utilize the `TEMPLATE_COMMIT` environment variable. If no template is provided, a default or global template will be used.
-- Use the `-m` or `--model` flag to specify the language model to use (default: `gpt-4`).
-
-## Contributing
-
-We welcome contributions to the commitai project! Please feel free to submit issues, feature requests, or pull requests.
-
-## License
-
-This project is released under the MIT License.
-
-

commitai-0.1.14.dist-info/RECORD

@@ -1,8 +0,0 @@
-commitai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-commitai/cli.py,sha256=2iBGpOOg74v0LeUWTf0GpKtcPr8MKizZ91dny-Svyz0,3950
-commitai/git.py,sha256=XWAloZWQuLrFHUyfh3SkOgLsL4kfKRtgj3fzuJjcL2A,1649
-commitai-0.1.14.dist-info/METADATA,sha256=GmeHM8d2NnHur_OXHcV746Lp7UM8O9NAXUe18mHxn14,4295
-commitai-0.1.14.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-commitai-0.1.14.dist-info/entry_points.txt,sha256=QbzYbxAVd7mBu9YlY9Q0KglNrWU-41feTmG7EvyvBhQ,48
-commitai-0.1.14.dist-info/top_level.txt,sha256=X76OfoBOic7IkaMkIgobuZxsVlsmcY_WMtBrtXtfn_w,9
-commitai-0.1.14.dist-info/RECORD,,

commitai-0.1.14.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-commitai = commitai.cli:main
-