rubber-ducky 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

ducky/ducky.py

@@ -2,41 +2,95 @@ import argparse
 from typing import Optional
 from langchain.llms.ollama import Ollama
 from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
+from termcolor import colored
 
+class RubberDuck:
+    """
+    This class is a wrapper around the Ollama model.
+    """
+    def __init__(self, model: str = "codellama") -> None:
+        """
+        This function initializes the RubberDuck class.
+
+        Args:
+            model (str, optional): The model to be used. Defaults to "codellama".
+        """
+        self.system_prompt = """You are a pair progamming tool to help developers debug, think through design, and write code. 
+        Help the user think through their approach and provide feedback on the code."""
+        self.llm = Ollama(model=model, callbacks=[StreamingStdOutCallbackHandler()], system=self.system_prompt)
+       
+
+    def call_llama(self, code: str = "", prompt: Optional[str] = None, chain: bool = False) -> None:
+        """
+        This function calls the Ollama model to provide feedback on the given code.
+
+        Args:
+            code (str): The code to be reviewed.
+            prompt (Optional[str]): Custom prompt to be used. Defaults to None.
+        """
+        if prompt is None:
+            prompt = "review the code, find any issues if any, suggest cleanups if any:" + code
+        else:
+            prompt = prompt + code
 
-def call_llama(code: str, prompt: Optional[str] = None) -> None:
+
+        self.llm(prompt)
+        if chain:
+            while(True):
+                prompt = input(colored("\n What's on your mind? \n ", 'green'))
+                self.llm(prompt)
+    
+
+def read_files_from_dir(directory: str) -> str:
     """
-    This function calls the Ollama model to provide feedback on the given code.
+    This function reads all the files from a directory and returns the concatenated string.
 
     Args:
-        code (str): The code to be reviewed.
-        prompt (Optional[str], optional): Custom prompt to be used. Defaults to None.
-    """
-    if prompt is None:
-        prompt = "review the code, find any issues if any, suggest cleanups if any:" + code
-    else:
-        prompt = prompt + code
-    system_prompt = """You are a pair progamming tool to help developers debug, think through design, and write code. Help the user rubber duck by providing feedback on the code."""
+        directory (str): The directory to be processed.
 
-    # TODO: find out how to enable the python trained model
-    llm = Ollama(model="codellama", callbacks=[StreamingStdOutCallbackHandler()], system=system_prompt)
+    Returns:
+        str: The concatenated string of all the files.
+    """
+    import os
+    files = os.listdir(directory)
+    code = ""
+    for file in files:
+        code += open(directory + "/" + file).read()
+    return code
 
-    # TODO: add chaining if it makes sense
-    llm(prompt)
 
 def ducky() -> None:
     """
     This function parses the command line arguments and calls the Ollama model.
     """
     parser = argparse.ArgumentParser()
-    parser.add_argument("--prompt", help="Custom prompt to be used", default=None)
-    parser.add_argument("--file", help="The file to be processed", default=None)
-    parser.add_argument("--directory", help="The directory to be processed", default=None)
+    parser.add_argument("--prompt", "-p", help="Custom prompt to be used", default=None)
+    parser.add_argument("--file", "-f", help="The file to be processed", default=None)
+    parser.add_argument("--directory", "-d", help="The directory to be processed", default=None)
+    parser.add_argument("--chain", "-c", help="Chain the output of the previous command to the next command", action="store_true", default=False)
+    parser.add_argument("--model", "-m", help="The model to be used", default="codellama")
     args, _ = parser.parse_known_args()
 
+    # My testing has shown that the codellama:7b-python is good for returning python code from the program.
+    # My intention with this tool was to give more general feedback and have back a back and forth with the user.
+    rubber_ducky = RubberDuck(model=args.model)
+    if args.file is None and args.directory is None:
+        if args.chain:
+            while(True):
+                prompt = input(colored("\n What's on your mind? \n ", 'green'))
+                rubber_ducky.call_llama(prompt=prompt, chain=args.chain)
+        else:
+            prompt = input(colored("\n What's on your mind? \n ", 'green'))
+            rubber_ducky.call_llama(prompt=prompt, chain=args.chain) 
+
     if args.file is not None:
         code = open(args.file).read()
-        call_llama(code=code, prompt=args.prompt)
+        rubber_ducky.call_llama(code=code, prompt=args.prompt, chain=args.chain)
+    
+    elif args.directory is not None:
+        code = read_files_from_dir(args.directory)
+        rubber_ducky.call_llama(code=code, prompt=args.prompt, chain=args.chain)
+    
 
 if __name__ == "__main__":
     ducky()

rubber_ducky-1.1.0.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: rubber-ducky
+Version: 1.1.0
+Summary: AI Companion for Pair Programming
+Home-page: https://github.com/ParthSareen/ducky
+Author: Parth Sareen
+Author-email: psareen@uwaterloo.ca
+License: MIT
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain
+Requires-Dist: termcolor
+
+# rubber ducky
+
+## tl;dr
+- `pip install rubber-ducky`
+- Install ollama
+- `ollama run codellama` (first time and then you can just have application in background)
+- There are probably other dependencies which I forgot to put in setup.py sorry in advance.
+- Run with `ducky -f <file path>`
+
+## Why did I make this 
+
+I wrote ducky because I annoy engineers too much and I needed to talk someone through my code quickly and validate my approach. Maybe this is why I'm not a senior engineer.
+
+Since I can't dump all my code to GPT and make it tell me I know how to code, I decided to build something for quick iteration. All. Local. I also didn't want to get fired by leaking all our data. Not again.
+
+## Dependencies
+Bless the folks at Ollama cause they have been carrying my recent projects.
+
+This project is currently only supported on Mac and Linux cause Ollama is a dependency.
+You will need Ollama installed on your machine. The model I use for this project is `codellama`. 
+
+For the first installation you can run `ollama run codellama` and it should pull the necessary binaries for you. Ollama is also great because it'll spin up a server which can run in the background and can even do automatic model switching as long as you have it installed.
+
+## Usage
+
+Install through [pypi](https://pypi.org/project/rubber-ducky/):
+
+`pip install rubber-ducky` .
+
+### Simple run
+`ducky`
+
+### To use additional options:
+
+`ducky --file <path> --prompt <prompt> --directory <directory> --chain --model <model>`
+
+Where:
+- `--prompt` or `-p`: Custom prompt to be used
+- `--file` or `-f`: The file to be processed
+- `--directory` or `-d`: The directory to be processed
+- `--chain` or `-c`: Chain the output of the previous command to the next command
+- `--model` or `-m`: The model to be used (default is "codellama")
+
+
+## Example output
+![Screenshot of ducky](image.png)

rubber_ducky-1.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ducky/__init__.py,sha256=_7imP8Jc2SIapn4fzGkspmKvqxPTFDcDJWHZ_o_MnlE,24
+ducky/ducky.py,sha256=LxL4jpd9oj77D5vh6s9h37zHw_AsK0TZ8BsEEfdUkew,3776
+rubber_ducky-1.1.0.dist-info/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
+rubber_ducky-1.1.0.dist-info/METADATA,sha256=zkZiaZ7Qg9OI0iDIRoPUZhOQcqtmdr3eY_KEf9LJIbU,2187
+rubber_ducky-1.1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+rubber_ducky-1.1.0.dist-info/entry_points.txt,sha256=Dpnmsfu54R9NqaSw8HZVsI52ICS3grSuSV_YwZa_x2Y,38
+rubber_ducky-1.1.0.dist-info/top_level.txt,sha256=4Q75MONDNPpQ3o17bTu7RFuKwFhTIRzlXP3_LDWQQ30,6
+rubber_ducky-1.1.0.dist-info/RECORD,,

rubber_ducky-1.0.0.dist-info/METADATA

@@ -1,31 +0,0 @@
-Metadata-Version: 2.1
-Name: rubber-ducky
-Version: 1.0.0
-Summary: AI Companion for Pair Programming
-Home-page: https://github.com/ParthSareen/ducky
-Author: Parth Sareen
-Author-email: psareen@uwaterloo.ca
-License: MIT
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: transformers
-
-# ducky
-
-Ducky Project
-Overview
-Ducky is a Python project that uses the ChatOllama language model from the langchain_core package. It's designed to generate responses based on a given prompt.
-Installation
-To install the necessary dependencies, you'll need to create a virtual environment and install the packages listed in the requirements.txt file.
-
-
-``` python
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements.txt
-```
-
-Usage
-To use Ducky, you'll need to run the ducky.py script with a prompt as an argument. The script will pass the prompt to the ChatOllama instance and print the generated response.
-
-`python ducky.py --prompt "Your prompt here"`

rubber_ducky-1.0.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-ducky/__init__.py,sha256=_7imP8Jc2SIapn4fzGkspmKvqxPTFDcDJWHZ_o_MnlE,24
-ducky/ducky.py,sha256=TCAQTgcEP8uexD1wQyBqBpYK8jqu_ZSVl3vf5duSJYw,1644
-rubber_ducky-1.0.0.dist-info/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
-rubber_ducky-1.0.0.dist-info/METADATA,sha256=WdNENSlfA_b8YIEKAHu3-G0NljHE36BVUF76hi3sRfE,982
-rubber_ducky-1.0.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-rubber_ducky-1.0.0.dist-info/entry_points.txt,sha256=Dpnmsfu54R9NqaSw8HZVsI52ICS3grSuSV_YwZa_x2Y,38
-rubber_ducky-1.0.0.dist-info/top_level.txt,sha256=4Q75MONDNPpQ3o17bTu7RFuKwFhTIRzlXP3_LDWQQ30,6
-rubber_ducky-1.0.0.dist-info/RECORD,,