commitai 1.0.4__py3-none-any.whl → 1.0.5__py3-none-any.whl

commitai/cli.py

@@ -2,11 +2,12 @@
 # -*- coding: utf-8 -*-
 
 import os
-from typing import Optional, Tuple
+from typing import Optional, Tuple, cast
 
 import click
 from langchain_anthropic import ChatAnthropic
 from langchain_core.language_models.chat_models import BaseChatModel
+from langchain_ollama import ChatOllama
 from langchain_openai import ChatOpenAI
 
 # Keep SecretStr import in case it's needed elsewhere or for future refinement
@@ -34,7 +35,6 @@ from commitai.template import (
 )
 
 
-# Helper function to get API key with priority
 def _get_google_api_key() -> Optional[str]:
     """Gets the Google API key from environment variables in priority order."""
     return (
@@ -44,7 +44,6 @@ def _get_google_api_key() -> Optional[str]:
     )
 
 
-# Helper function to initialize the LLM
 def _initialize_llm(model: str) -> BaseChatModel:
     """Initializes and returns the LangChain chat model based on the model name."""
     google_api_key_str = _get_google_api_key()
@@ -56,17 +55,16 @@ def _initialize_llm(model: str) -> BaseChatModel:
                 raise click.ClickException(
                     "Error: OPENAI_API_KEY environment variable not set."
                 )
-            # Pass raw string and ignore Mypy SecretStr complaint
             return ChatOpenAI(model=model, api_key=api_key, temperature=0.7)
+
         elif model.startswith("claude-"):
             api_key = os.getenv("ANTHROPIC_API_KEY")
             if not api_key:
                 raise click.ClickException(
                     "Error: ANTHROPIC_API_KEY environment variable not set."
                 )
-            # Pass raw string and ignore Mypy SecretStr complaint
-            # Also ignore missing timeout argument if it's optional
             return ChatAnthropic(model_name=model, api_key=api_key, temperature=0.7)
+
         elif model.startswith("gemini-"):
             if ChatGoogleGenerativeAI is None:
                 raise click.ClickException(
@@ -79,30 +77,23 @@ def _initialize_llm(model: str) -> BaseChatModel:
                     "Error: Google API Key not found. Set GOOGLE_API_KEY, "
                     "GEMINI_API_KEY, or GOOGLE_GENERATIVE_AI_API_KEY."
                 )
-            # Pass raw string and ignore Mypy SecretStr complaint
-            # Also ignore missing optional arguments
             return ChatGoogleGenerativeAI(
                 model=model,
                 google_api_key=google_api_key_str,
                 temperature=0.7,
                 convert_system_message_to_human=True,
             )
+        elif model.startswith("llama"):
+            # Ollama models (e.g., llama2, llama3)
+            return cast(BaseChatModel, ChatOllama(model=model, temperature=0.7))
         else:
             raise click.ClickException(f"🚫 Unsupported model: {model}")
+
     except Exception as e:
         raise click.ClickException(f"Error initializing AI model: {e}") from e
 
 
-# Helper function to prepare context (diff, repo, branch)
 def _prepare_context() -> str:
-    """
-    Gets the repository context (name, branch, diff).
-
-    Returns:
-        str: The formatted diff string.
-    Raises:
-        click.ClickException: If no staged changes are found.
-    """
     diff = get_staged_changes_diff()
     if not diff:
         raise click.ClickException("⚠️ Warning: No staged changes found. Exiting.")
@@ -112,11 +103,9 @@ def _prepare_context() -> str:
     return f"{repo_name}/{branch_name}\n\n{diff}"
 
 
-# Helper function to build the final prompt
 def _build_prompt(
     explanation: str, formatted_diff: str, template: Optional[str]
 ) -> str:
-    """Builds the complete prompt for the AI model."""
     system_message = default_system_message
     if template:
         system_message += adding_template
@@ -130,14 +119,7 @@ def _build_prompt(
     return f"{system_message}\n\n{diff_message}"
 
 
-# Helper function to handle commit message editing and creation
 def _handle_commit(commit_message: str, commit_flag: bool) -> None:
-    """
-    Writes message, optionally opens editor, and creates the commit.
-
-    Raises:
-        click.ClickException: On file I/O errors or if the commit is aborted.
-    """
     repo_path = get_repository_name()
     git_dir = os.path.join(repo_path, ".git")
     try:
@@ -180,7 +162,6 @@ def _handle_commit(commit_message: str, commit_flag: bool) -> None:
 
 @click.group(context_settings={"help_option_names": ["-h", "--help"]})
 def cli() -> None:
-    """CommitAi CLI group."""
     pass
 
 
@@ -224,7 +205,6 @@ def generate_message(
     add: bool,
     model: str,
 ) -> None:
-    """Generates a commit message based on staged changes and description."""
     explanation = " ".join(description)
 
     llm = _initialize_llm(model)

{commitai-1.0.4.dist-info → commitai-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commitai
-Version: 1.0.4
+Version: 1.0.5
 Summary: Commitai helps you generate git commit messages using AI
 Project-URL: Bug Tracker, https://github.com/lguibr/commitai/issues
 Project-URL: Documentation, https://github.com/lguibr/commitai/blob/main/README.md
@@ -42,15 +42,16 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 Classifier: Topic :: Utilities
 Requires-Python: >=3.9
 Requires-Dist: click<9.0,>=8.0
-Requires-Dist: langchain-anthropic<0.3.0,>=0.1.0
-Requires-Dist: langchain-community<0.2.0,>=0.0.20
-Requires-Dist: langchain-core<0.3.0,>=0.1.0
-Requires-Dist: langchain-google-genai~=0.0.9
-Requires-Dist: langchain-openai<0.3.0,>=0.1.0
-Requires-Dist: langchain<0.3.0,>=0.1.0
+Requires-Dist: langchain-anthropic<=0.3.12,>=0.1.0
+Requires-Dist: langchain-community<=0.3.23,>=0.0.20
+Requires-Dist: langchain-core<=0.3.58,>=0.1.0
+Requires-Dist: langchain-google-genai~=2.1.4
+Requires-Dist: langchain-ollama~=0.3.2
+Requires-Dist: langchain-openai<=0.3.16,>=0.1.0
+Requires-Dist: langchain<=0.3.25,>=0.1.0
 Requires-Dist: pydantic<3.0,>=2.0
 Provides-Extra: test
-Requires-Dist: langchain-google-genai~=0.0.9; extra == 'test'
+Requires-Dist: langchain-google-genai~=2.1.4; extra == 'test'
 Requires-Dist: mypy>=1.9.0; extra == 'test'
 Requires-Dist: pytest-cov>=3.0; extra == 'test'
 Requires-Dist: pytest>=7.0; extra == 'test'
@@ -67,9 +68,13 @@ Description-Content-Type: text/markdown
 [![License](https://img.shields.io/pypi/l/CommitAi.svg)](https://github.com/lguibr/CommitAi/blob/main/LICENSE)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-<p align="center">
-  <img src="bitmap.png" alt="Logo" width="300"/>
-</p>
+
+<img
+  src="https://raw.githubusercontent.com/lguibr/commitai/main/bitmap.png"
+  alt="screenshot"
+  width="400"
+/>
+
 
 **Tired of writing Git commit messages? Let AI do the heavy lifting!**
 
@@ -102,7 +107,7 @@ Simply stage your files and run `commitai`. It analyzes the diff, optionally tak
 *   📝 **Optional Explanations**: Provide a high-level description of your changes as input to guide the AI, or let it infer the context solely from the code diff.
 *   ✅ **Pre-commit Hook Integration**: Automatically runs your existing native Git pre-commit hook (`.git/hooks/pre-commit`) before generating the message, ensuring code quality and style checks pass.
 *   🔧 **Customizable Prompts via Templates**: Add custom instructions or context to the AI prompt using global environment variables or repository-specific template files.
-*   🤖 **Multiple AI Provider Support**: Choose your preferred AI model from OpenAI, Anthropic, or Google.
+*   🤖 **Multiple AI Provider Support**: Choose your preferred AI model from OpenAI, Anthropic, Google or local AI models with Ollama.
 *   ⚙️ **Flexible Workflow**:
     *   Stages all changes automatically (`-a` flag).
     *   Reviews message in your default Git editor (default behavior).
@@ -154,6 +159,14 @@ CommitAi requires API keys for the AI provider you intend to use. Set these as e
 
 You only need to set the key for the provider corresponding to the model you select (or the default, Gemini).
 
+### Ollama
+
+CommitAi can also work with Ollama models:
+```bash
+export OLLAMA_HOST="your_ollama_base_url"
+```
+
+
 ### Commit Templates (Optional)
 
 You can add custom instructions to the default system prompt used by the AI. This is useful for enforcing project-specific guidelines (e.g., mentioning ticket numbers).
@@ -290,7 +303,7 @@ Contributions are highly welcome! Please follow these steps:
 9.  Run checks locally before committing:
     *   Format code: `ruff format .`
     *   Lint code: `ruff check .`
-    *   Run type checks: `mypy commitai commitai/tests`
+    *   Run type checks: `mypy commitai tests`
     *   Run tests: `pytest`
 10. Commit your changes (you can use `commitai`!).
 11. Push your branch to your fork: `git push origin my-feature-branch`

commitai-1.0.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+commitai/__init__.py,sha256=Z5hB8NLKlfi7oPDRcDSQmtPSo_arLjoa6jwjFt3Pb9o,388
+commitai/cli.py,sha256=ClIF6hLekc4gRg9IAUDK9d-y4ee7kvJcZuTt9NCfFRg,9732
+commitai/git.py,sha256=XWAloZWQuLrFHUyfh3SkOgLsL4kfKRtgj3fzuJjcL2A,1649
+commitai/template.py,sha256=q4AO64hKhJP2y9DCc5-ePFoRZfOQBkbkB6vt8CnoMh8,1379
+commitai-1.0.5.dist-info/METADATA,sha256=_wO_IflHPj969OHjwzuQ-kCgV0DPgJ9ChPi8qPjBJPs,13710
+commitai-1.0.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+commitai-1.0.5.dist-info/entry_points.txt,sha256=qzWJQdPoR38mjQgRPRCB3tA7Kojtj3WrozlFWR4KhLY,128
+commitai-1.0.5.dist-info/licenses/LICENSE,sha256=wVkmSz0UMpGw0xYxk4AmkPLd_tVFcuszTdNIoq02tJA,1087
+commitai-1.0.5.dist-info/RECORD,,

commitai-1.0.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-commitai/__init__.py,sha256=Z5hB8NLKlfi7oPDRcDSQmtPSo_arLjoa6jwjFt3Pb9o,388
-commitai/cli.py,sha256=-uM5xYOvQ8NUDQM4fJ1Ktk3st9d5QxtT55rbTFP7e_o,10620
-commitai/git.py,sha256=XWAloZWQuLrFHUyfh3SkOgLsL4kfKRtgj3fzuJjcL2A,1649
-commitai/template.py,sha256=q4AO64hKhJP2y9DCc5-ePFoRZfOQBkbkB6vt8CnoMh8,1379
-commitai-1.0.4.dist-info/METADATA,sha256=iOijXC_ZayBVdArer0z-htp9mso3iqhBHwpRQyXSB0U,13487
-commitai-1.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-commitai-1.0.4.dist-info/entry_points.txt,sha256=qzWJQdPoR38mjQgRPRCB3tA7Kojtj3WrozlFWR4KhLY,128
-commitai-1.0.4.dist-info/licenses/LICENSE,sha256=wVkmSz0UMpGw0xYxk4AmkPLd_tVFcuszTdNIoq02tJA,1087
-commitai-1.0.4.dist-info/RECORD,,