rubber-ducky 1.0.1__py3-none-any.whl → 1.1.1__py3-none-any.whl

ducky/ducky.py

@@ -1,44 +1,95 @@
 import argparse
+import asyncio
 from typing import Optional
-from langchain.llms.ollama import Ollama
-from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
+from ollama import AsyncClient
 
 
-def call_llama(code: str, prompt: Optional[str] = None) -> None:
-    """
-    This function calls the Ollama model to provide feedback on the given code.
+class RubberDuck:
+    def __init__(self, model: str = "codellama") -> None:
+        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. Think step by step and ask clarifying questions if needed."""
+        self.client = AsyncClient()
+        self.model = model
+
+    async def call_llama(self, code: str = "", prompt: Optional[str] = None, chain: bool = False) -> None:
+        if prompt is None:
+            user_prompt = input("\nEnter your prompt (or press Enter for default review): ")
+            if not user_prompt:
+                prompt = "review the code, find any issues if any, suggest cleanups if any:" + code
+            else:
+                prompt = user_prompt + code
+        else:
+            prompt = prompt + code
+
+        responses = []
+        while True:
+            # Include previous responses in the prompt for context
+            context_prompt = "\n".join(responses) + "\n" + prompt
+            response = await self.client.generate(model="codellama", prompt=context_prompt)
+            print(response['response'])
+            responses.append(response['response'])
+            if not chain:
+                break
+            prompt = input("\nAny questions? \n")
 
-    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."""
 
-    # TODO: find out how to enable the python trained model
-    llm = Ollama(model="codellama", callbacks=[StreamingStdOutCallbackHandler()], system=system_prompt)
+def read_files_from_dir(directory: str) -> str:
+    import os
 
-    # TODO: add chaining if it makes sense
-    llm(prompt)
+    files = os.listdir(directory)
+    code = ""
+    for file in files:
+        code += open(directory + "/" + file).read()
+    return code
 
-def ducky() -> None:
-    """
-    This function parses the command line arguments and calls the Ollama model.
-    """
+
+async def ducky() -> None:
     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("question", nargs="?", help="Direct question to ask", 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)
+
+    # Handle direct question from CLI
+    if args.question is not None:
+        await rubber_ducky.call_llama(prompt=args.question, chain=args.chain)
+        return
+
+    if args.file is None and args.directory is None:
+        # Handle interactive mode (no file/directory specified)
+        await rubber_ducky.call_llama(prompt=args.prompt, chain=args.chain)
+        if args.chain:
+            while True:
+                await rubber_ducky.call_llama(prompt=args.prompt, chain=args.chain)
+        return
+
+    # Handle file input
     if args.file is not None:
         code = open(args.file).read()
-        call_llama(code=code, prompt=args.prompt)
+    # Handle directory input
     else:
-        raise Exception("No file provided")
+        code = read_files_from_dir(args.directory)
+        
+    await rubber_ducky.call_llama(code=code, prompt=args.prompt, chain=args.chain)
+
+
+def main():
+    asyncio.run(ducky())
 
 if __name__ == "__main__":
-    ducky()
+    main()

rubber_ducky-1.1.1.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.1
+Name: rubber-ducky
+Version: 1.1.1
+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: ollama
+
+# rubber ducky
+
+## tl;dr
+- `pip install rubber-ducky`
+- Install ollama
+- `ollama pull 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 <path>` or `ducky <question>`
+
+## Dependencies
+
+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 pull 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`
+
+or 
+
+`ducky <question>`
+
+or 
+
+`ducky -f <path>`
+
+
+### All 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.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+ducky/__init__.py,sha256=_7imP8Jc2SIapn4fzGkspmKvqxPTFDcDJWHZ_o_MnlE,24
+ducky/ducky.py,sha256=NwOzoLMd7fzimq-4OkfEL6buACY2Y13cze2uLEerVBU,3540
+rubber_ducky-1.1.1.dist-info/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
+rubber_ducky-1.1.1.dist-info/METADATA,sha256=uPUKC85hZxy2j2jVojKPzWH_rVYt1GAAB7Z1deWUFbk,1638
+rubber_ducky-1.1.1.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+rubber_ducky-1.1.1.dist-info/entry_points.txt,sha256=LPndtj8UqEWtwYApv5LJJniH4FUrsriOqV2LA1X_UPQ,43
+rubber_ducky-1.1.1.dist-info/top_level.txt,sha256=4Q75MONDNPpQ3o17bTu7RFuKwFhTIRzlXP3_LDWQQ30,6
+rubber_ducky-1.1.1.dist-info/RECORD,,

{rubber_ducky-1.0.1.dist-info → rubber_ducky-1.1.1.dist-info}/WHEEL

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

rubber_ducky-1.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ducky = ducky.ducky:main

rubber_ducky-1.0.1.dist-info/METADATA

@@ -1,45 +0,0 @@
-Metadata-Version: 2.1
-Name: rubber-ducky
-Version: 1.0.1
-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
-
-# 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 --file <path> --prompt (optional) <prompt to override>`
-
-## 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
-Make sure you have the package installed. Easiest through [pypi](https://pypi.org/project/rubber-ducky/). 
-
-`pip install rubber-ducky` also works.
-
-To run:
-
-`ducky --file <path> --prompt (optional) <prompt to override>`
-
-I have yet to implement some methods so if you do something I don't say that's on you.

rubber_ducky-1.0.1.dist-info/RECORD

@@ -1,8 +0,0 @@
-ducky/__init__.py,sha256=_7imP8Jc2SIapn4fzGkspmKvqxPTFDcDJWHZ_o_MnlE,24
-ducky/ducky.py,sha256=Yc3eHtn9zf0tFdxhAkHPCmpdNoGlJ_5Fvwjp_-j6xyE,1698
-rubber_ducky-1.0.1.dist-info/LICENSE,sha256=gQ1rCmw18NqTk5GxG96F6vgyN70e1c4kcKUtWDwdNaE,1069
-rubber_ducky-1.0.1.dist-info/METADATA,sha256=FzklJu6cdH6MVPWFCpYJXlG2f4dVHTy8KSD6LppIWnY,1912
-rubber_ducky-1.0.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-rubber_ducky-1.0.1.dist-info/entry_points.txt,sha256=Dpnmsfu54R9NqaSw8HZVsI52ICS3grSuSV_YwZa_x2Y,38
-rubber_ducky-1.0.1.dist-info/top_level.txt,sha256=4Q75MONDNPpQ3o17bTu7RFuKwFhTIRzlXP3_LDWQQ30,6
-rubber_ducky-1.0.1.dist-info/RECORD,,

rubber_ducky-1.0.1.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-ducky = ducky:ducky