patchllm 0.1.1__tar.gz → 0.2.2__tar.gz

patchllm-0.2.2/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: patchllm
+Version: 0.2.2
+Summary: Lightweight tool to manage contexts and update code with LLMs
+Author: nassimberrada
+License: MIT License
+        
+        Copyright (c) 2025 nassimberrada
+        
+        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.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: litellm
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Provides-Extra: voice
+Requires-Dist: SpeechRecognition; extra == "voice"
+Requires-Dist: pyttsx3; extra == "voice"
+Provides-Extra: url
+Requires-Dist: html2text; extra == "url"
+Dynamic: license-file
+
+<p align="center">
+  <picture>
+    <source srcset="./assets/logo_dark.png" media="(prefers-color-scheme: dark)">
+    <source srcset="./assets/logo_light.png" media="(prefers-color-scheme: light)">
+    <img src="./assets/logo_light.png" alt="PatchLLM Logo" height="200">
+  </picture>
+</p>
+
+## About
+PatchLLM is a command-line tool that lets you flexibly build LLM context from your codebase using glob patterns, URLs, and keyword searches. It then automatically applies file edits directly from the LLM's response.
+
+## Usage
+PatchLLM is designed to be used directly from your terminal. The core workflow is to define a **scope** of files, provide a **task**, and choose an **action** (like patching files directly).
+
+### 1. Initialize a Scope
+The easiest way to get started is to run the interactive initializer. This will create a `scopes.py` file for you, which holds your saved scopes.
+
+```bash
+patchllm --init
+```
+
+This will guide you through creating your first scope, including setting a base path and file patterns. You can add multiple scopes to this file for different projects or tasks.
+
+A generated `scopes.py` might look like this:
+```python
+# scopes.py
+scopes = {
+    "default": {
+        "path": ".",
+        "include_patterns": ["**/*.py"],
+        "exclude_patterns": ["**/tests/*", "venv/*"],
+        "urls": ["https://docs.python.org/3/library/argparse.html"]
+    },
+    "docs": {
+        "path": "./docs",
+        "include_patterns": ["**/*.md"],
+    }
+}
+```
+
+### 2. Run a Task
+Use the `patchllm` command with a scope, a task, and an action flag like `--patch` (`-p`).
+
+```bash
+# Apply a change using the 'default' scope and the --patch action
+patchllm -s default -t "Add type hints to the main function in main.py" -p
+```
+
+The tool will then:
+1.  Build a context from the files and URLs matching your `default` scope.
+2.  Send the context and your task to the configured LLM.
+3.  Parse the response and automatically write the changes to the relevant files.
+
+### All Commands & Options
+
+#### Core Patching Flow
+*   `-s, --scope <name>`: Name of the scope to use from your `scopes.py` file.
+*   `-t, --task "<instruction>"`: The task instruction for the LLM.
+*   `-p, --patch`: Query the LLM and directly apply the file updates from the response. **This is the main action flag.**
+
+#### Scope Management
+*   `-i, --init`: Create a new scope interactively.
+*   `-sl, --list-scopes`: List all available scopes from your `scopes.py` file.
+*   `-ss, --show-scope <name>`: Display the settings for a specific scope.
+
+#### I/O & Context Management
+*   `-co, --context-out [filename]`: Export the generated context to a file (defaults to `context.md`) instead of running a task.
+*   `-ci, --context-in <filename>`: Use a previously saved context file as input for a task.
+*   `-tf, --to-file [filename]`: Send the LLM response to a file (defaults to `response.md`) instead of patching directly.
+*   `-tc, --to-clipboard`: Copy the LLM response to the clipboard.
+*   `-ff, --from-file <filename>`: Apply patches from a local file instead of an LLM response.
+*   `-fc, --from-clipboard`: Apply patches directly from your clipboard content.
+
+#### General Options
+*   `--model <model_name>`: Specify a different model (e.g., `gpt-4o`). Defaults to `gemini/gemini-1.5-flash`.
+*   `--voice`: Enable voice recognition to provide the task instruction.
+
+### Setup
+
+PatchLLM uses [LiteLLM](https://github.com/BerriAI/litellm) under the hood. Please refer to their documentation for setting up API keys (e.g., `OPENAI_API_KEY`, `GEMINI_API_KEY`) in a `.env` file and for a full list of available models.
+
+To use the voice feature (`--voice`), you will need to install extra dependencies:
+```bash
+pip install "speechrecognition>=3.10" "pyttsx3>=2.90"
+# Note: speechrecognition may require PyAudio, which might have system-level dependencies.
+```
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

patchllm-0.2.2/README.md

@@ -0,0 +1,90 @@
+<p align="center">
+  <picture>
+    <source srcset="./assets/logo_dark.png" media="(prefers-color-scheme: dark)">
+    <source srcset="./assets/logo_light.png" media="(prefers-color-scheme: light)">
+    <img src="./assets/logo_light.png" alt="PatchLLM Logo" height="200">
+  </picture>
+</p>
+
+## About
+PatchLLM is a command-line tool that lets you flexibly build LLM context from your codebase using glob patterns, URLs, and keyword searches. It then automatically applies file edits directly from the LLM's response.
+
+## Usage
+PatchLLM is designed to be used directly from your terminal. The core workflow is to define a **scope** of files, provide a **task**, and choose an **action** (like patching files directly).
+
+### 1. Initialize a Scope
+The easiest way to get started is to run the interactive initializer. This will create a `scopes.py` file for you, which holds your saved scopes.
+
+```bash
+patchllm --init
+```
+
+This will guide you through creating your first scope, including setting a base path and file patterns. You can add multiple scopes to this file for different projects or tasks.
+
+A generated `scopes.py` might look like this:
+```python
+# scopes.py
+scopes = {
+    "default": {
+        "path": ".",
+        "include_patterns": ["**/*.py"],
+        "exclude_patterns": ["**/tests/*", "venv/*"],
+        "urls": ["https://docs.python.org/3/library/argparse.html"]
+    },
+    "docs": {
+        "path": "./docs",
+        "include_patterns": ["**/*.md"],
+    }
+}
+```
+
+### 2. Run a Task
+Use the `patchllm` command with a scope, a task, and an action flag like `--patch` (`-p`).
+
+```bash
+# Apply a change using the 'default' scope and the --patch action
+patchllm -s default -t "Add type hints to the main function in main.py" -p
+```
+
+The tool will then:
+1.  Build a context from the files and URLs matching your `default` scope.
+2.  Send the context and your task to the configured LLM.
+3.  Parse the response and automatically write the changes to the relevant files.
+
+### All Commands & Options
+
+#### Core Patching Flow
+*   `-s, --scope <name>`: Name of the scope to use from your `scopes.py` file.
+*   `-t, --task "<instruction>"`: The task instruction for the LLM.
+*   `-p, --patch`: Query the LLM and directly apply the file updates from the response. **This is the main action flag.**
+
+#### Scope Management
+*   `-i, --init`: Create a new scope interactively.
+*   `-sl, --list-scopes`: List all available scopes from your `scopes.py` file.
+*   `-ss, --show-scope <name>`: Display the settings for a specific scope.
+
+#### I/O & Context Management
+*   `-co, --context-out [filename]`: Export the generated context to a file (defaults to `context.md`) instead of running a task.
+*   `-ci, --context-in <filename>`: Use a previously saved context file as input for a task.
+*   `-tf, --to-file [filename]`: Send the LLM response to a file (defaults to `response.md`) instead of patching directly.
+*   `-tc, --to-clipboard`: Copy the LLM response to the clipboard.
+*   `-ff, --from-file <filename>`: Apply patches from a local file instead of an LLM response.
+*   `-fc, --from-clipboard`: Apply patches directly from your clipboard content.
+
+#### General Options
+*   `--model <model_name>`: Specify a different model (e.g., `gpt-4o`). Defaults to `gemini/gemini-1.5-flash`.
+*   `--voice`: Enable voice recognition to provide the task instruction.
+
+### Setup
+
+PatchLLM uses [LiteLLM](https://github.com/BerriAI/litellm) under the hood. Please refer to their documentation for setting up API keys (e.g., `OPENAI_API_KEY`, `GEMINI_API_KEY`) in a `.env` file and for a full list of available models.
+
+To use the voice feature (`--voice`), you will need to install extra dependencies:
+```bash
+pip install "speechrecognition>=3.10" "pyttsx3>=2.90"
+# Note: speechrecognition may require PyAudio, which might have system-level dependencies.
+```
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

{patchllm-0.1.1 → patchllm-0.2.2}/patchllm/context.py

@@ -1,8 +1,11 @@
-import os
 import glob
 import textwrap
-import sys
+import subprocess
+import shutil
 from pathlib import Path
+from rich.console import Console
+
+console = Console()
 
 # --- Default Settings & Templates ---
 
@@ -29,12 +32,19 @@ BASE_TEMPLATE = textwrap.dedent('''
     ```
     {{source_tree}}
     ```
-
+    {{url_contents}}
     Relevant Files:
     ---------------
     {{files_content}}
 ''')
 
+URL_CONTENT_TEMPLATE = textwrap.dedent('''
+    URL Contents:
+    -------------
+    {{content}}
+''')
+
+
 # --- Helper Functions (File Discovery, Filtering, Tree Generation) ---
 
 def find_files(base_path: Path, include_patterns: list[str], exclude_patterns: list[str] | None = None) -> list[Path]:
@@ -70,11 +80,10 @@ def filter_files_by_keyword(file_paths: list[Path], search_words: list[str]) ->
     matching_files = []
     for file_path in file_paths:
         try:
-            # Using pathlib's read_text for cleaner code
             if any(word in file_path.read_text(encoding='utf-8', errors='ignore') for word in search_words):
                 matching_files.append(file_path)
         except Exception as e:
-            print(f"Warning: Could not read {file_path} for keyword search: {e}", file=sys.stderr)
+            console.print(f"⚠️  Could not read {file_path} for keyword search: {e}", style="yellow")
     return matching_files
 
 
@@ -86,11 +95,8 @@ def generate_source_tree(base_path: Path, file_paths: list[Path]) -> str:
     tree = {}
     for path in file_paths:
         try:
-            # Create a path relative to the intended base_path for the tree structure
             rel_path = path.relative_to(base_path)
         except ValueError:
-            # This occurs if a file (from an absolute pattern) is outside the base_path.
-            # In this case, we use the absolute path as a fallback.
             rel_path = path
             
         level = tree
@@ -112,25 +118,80 @@ def generate_source_tree(base_path: Path, file_paths: list[Path]) -> str:
     return f"{base_path.name}\n" + "\n".join(_format_tree(tree))
 
 
+def fetch_and_process_urls(urls: list[str]) -> str:
+    """Downloads and converts a list of URLs to text, returning a formatted string."""
+    if not urls:
+        return ""
+
+    try:
+        import html2text
+    except ImportError:
+        console.print("⚠️  To use the URL feature, please install the required extras:", style="yellow")
+        console.print("   pip install patchllm[url]", style="cyan")
+        return ""
+
+    downloader = None
+    if shutil.which("curl"):
+        downloader = "curl"
+    elif shutil.which("wget"):
+        downloader = "wget"
+
+    if not downloader:
+        console.print("⚠️  Cannot fetch URL content: 'curl' or 'wget' not found in PATH.", style="yellow")
+        return ""
+
+    h = html2text.HTML2Text()
+    h.ignore_links = True
+    h.ignore_images = True
+    
+    all_url_contents = []
+
+    console.print("\n--- Fetching URL Content... ---", style="bold")
+    for url in urls:
+        try:
+            console.print(f"Fetching [cyan]{url}[/cyan]...")
+            if downloader == "curl":
+                command = ["curl", "-s", "-L", url]
+            else: # wget
+                command = ["wget", "-q", "-O", "-", url]
+
+            result = subprocess.run(command, capture_output=True, text=True, check=True, timeout=15)
+            html_content = result.stdout
+            text_content = h.handle(html_content)
+            all_url_contents.append(f"<url_content:{url}>\n```\n{text_content}\n```")
+
+        except subprocess.CalledProcessError as e:
+            console.print(f"❌ Failed to fetch {url}: {e.stderr}", style="red")
+        except subprocess.TimeoutExpired:
+            console.print(f"❌ Failed to fetch {url}: Request timed out.", style="red")
+        except Exception as e:
+            console.print(f"❌ An unexpected error occurred while fetching {url}: {e}", style="red")
+
+    if not all_url_contents:
+        return ""
+    
+    content_str = "\n\n".join(all_url_contents)
+    return URL_CONTENT_TEMPLATE.replace("{{content}}", content_str)
+
 # --- Main Context Building Function ---
 
-def build_context(config: dict) -> dict | None:
+def build_context(scope: dict) -> dict | None:
     """
-    Builds the context string from files specified in the config.
+    Builds the context string from files specified in the scope.
 
     Args:
-        config (dict): The configuration for file searching.
+        scope (dict): The scope for file searching.
 
     Returns:
         dict: A dictionary with the source tree and formatted context, or None.
     """
-    # Resolve the base path immediately to get a predictable absolute path.
-    base_path = Path(config.get("path", ".")).resolve()
+    base_path = Path(scope.get("path", ".")).resolve()
     
-    include_patterns = config.get("include_patterns", [])
-    exclude_patterns = config.get("exclude_patterns", [])
-    exclude_extensions = config.get("exclude_extensions", DEFAULT_EXCLUDE_EXTENSIONS)
-    search_words = config.get("search_words", [])
+    include_patterns = scope.get("include_patterns", [])
+    exclude_patterns = scope.get("exclude_patterns", [])
+    exclude_extensions = scope.get("exclude_extensions", DEFAULT_EXCLUDE_EXTENSIONS)
+    search_words = scope.get("search_words", [])
+    urls = scope.get("urls", [])
 
     # Step 1: Find files
     relevant_files = find_files(base_path, include_patterns, exclude_patterns)
@@ -140,20 +201,18 @@ def build_context(config: dict) -> dict | None:
     norm_ext = {ext.lower() for ext in exclude_extensions}
     relevant_files = [p for p in relevant_files if p.suffix.lower() not in norm_ext]
     if count_before_ext > len(relevant_files):
-        print(f"Filtered {count_before_ext - len(relevant_files)} files by extension.")
+        console.print(f"Filtered {count_before_ext - len(relevant_files)} files by extension.", style="cyan")
 
     # Step 3: Filter by keyword
     if search_words:
         count_before_kw = len(relevant_files)
         relevant_files = filter_files_by_keyword(relevant_files, search_words)
-        print(f"Filtered {count_before_kw - len(relevant_files)} files by keyword search.")
+        console.print(f"Filtered {count_before_kw - len(relevant_files)} files by keyword search.", style="cyan")
 
-    if not relevant_files:
-        print("\nNo files matched the specified criteria.")
+    if not relevant_files and not urls:
+        console.print("\n⚠️  No files or URLs matched the specified criteria.", style="yellow")
         return None
 
-    print(f"\nFinal count of relevant files: {len(relevant_files)}.")
-
     # Generate source tree and file content blocks
     source_tree_str = generate_source_tree(base_path, relevant_files)
     
@@ -164,12 +223,16 @@ def build_context(config: dict) -> dict | None:
             content = file_path.read_text(encoding='utf-8')
             file_contents.append(f"<file_path:{display_path}>\n```\n{content}\n```")
         except Exception as e:
-            print(f"Warning: Could not read file {file_path}: {e}", file=sys.stderr)
+            console.print(f"⚠️  Could not read file {file_path}: {e}", style="yellow")
 
     files_content_str = "\n\n".join(file_contents)
 
+    # Fetch and process URL contents
+    url_contents_str = fetch_and_process_urls(urls)
+
     # Assemble the final context using the base template
     final_context = BASE_TEMPLATE.replace("{{source_tree}}", source_tree_str)
+    final_context = final_context.replace("{{url_contents}}", url_contents_str)
     final_context = final_context.replace("{{files_content}}", files_content_str)
     
     return {"tree": source_tree_str, "context": final_context}

{patchllm-0.1.1 → patchllm-0.2.2}/patchllm/listener.py

@@ -1,11 +1,13 @@
 import speech_recognition as sr
 import pyttsx3
+from rich.console import Console
 
+console = Console()
 recognizer = sr.Recognizer()
 tts_engine = pyttsx3.init()
 
 def speak(text):
-    print("🤖 Speaking:", text)
+    console.print(f"🤖 Speaking: {text}", style="magenta")
     tts_engine.say(text)
     tts_engine.runAndWait()
 
@@ -13,11 +15,11 @@ def listen(prompt=None, timeout=5):
     with sr.Microphone() as source:
         if prompt:
             speak(prompt)
-        print("🎙 Listening...")
+        console.print("🎙 Listening...", style="cyan")
         try:
             audio = recognizer.listen(source, timeout=timeout)
             text = recognizer.recognize_google(audio)
-            print(f"🗣 Recognized: {text}")
+            console.print(f"🗣 Recognized: {text}", style="cyan")
             return text
         except sr.WaitTimeoutError:
             speak("No speech detected.")
@@ -25,4 +27,4 @@ def listen(prompt=None, timeout=5):
             speak("Sorry, I didn’t catch that.")
         except sr.RequestError:
             speak("Speech recognition failed. Check your internet.")
-    return None
+    return None