rubber-ducky 1.1.0__tar.gz → 1.1.2__tar.gz

{rubber-ducky-1.1.0 → rubber_ducky-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rubber-ducky
-Version: 1.1.0
+Version: 1.1.2
 Summary: AI Companion for Pair Programming
 Home-page: https://github.com/ParthSareen/ducky
 Author: Parth Sareen
@@ -8,31 +8,24 @@ Author-email: psareen@uwaterloo.ca
 License: MIT
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: langchain
-Requires-Dist: termcolor
+Requires-Dist: ollama
 
 # rubber ducky
 
 ## tl;dr
 - `pip install rubber-ducky`
 - Install ollama
-- `ollama run codellama` (first time and then you can just have application in background)
+- `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 -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.
+- Run with `ducky <path>` or `ducky <question>`
 
 ## 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.
+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
 
@@ -43,8 +36,16 @@ Install through [pypi](https://pypi.org/project/rubber-ducky/):
 ### Simple run
 `ducky`
 
-### To use additional options:
+or 
+
+`ducky <question>`
+
+or 
+
+`ducky -f <path>`
+
 
+### All options
 `ducky --file <path> --prompt <prompt> --directory <directory> --chain --model <model>`
 
 Where:

rubber_ducky-1.1.2/README.md

@@ -0,0 +1,48 @@
+# 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.2/ducky/ducky.py

@@ -0,0 +1,96 @@
+import argparse
+import asyncio
+from typing import Optional
+from ollama import AsyncClient
+
+
+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=self.model, prompt=context_prompt)
+            print(response['response'])
+            responses.append(response['response'])
+            if not chain:
+                break
+            prompt = input("\nAny questions? \n")
+
+
+def read_files_from_dir(directory: str) -> str:
+    import os
+
+    files = os.listdir(directory)
+    code = ""
+    for file in files:
+        code += open(directory + "/" + file).read()
+    return code
+
+
+async def ducky() -> None:
+    parser = argparse.ArgumentParser()
+    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:
+        question = " ".join(args.question)
+        await rubber_ducky.call_llama(prompt=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()
+    # Handle directory input
+    else:
+        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__":
+    main()

{rubber-ducky-1.1.0 → rubber_ducky-1.1.2}/rubber_ducky.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rubber-ducky
-Version: 1.1.0
+Version: 1.1.2
 Summary: AI Companion for Pair Programming
 Home-page: https://github.com/ParthSareen/ducky
 Author: Parth Sareen
@@ -8,31 +8,24 @@ Author-email: psareen@uwaterloo.ca
 License: MIT
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: langchain
-Requires-Dist: termcolor
+Requires-Dist: ollama
 
 # rubber ducky
 
 ## tl;dr
 - `pip install rubber-ducky`
 - Install ollama
-- `ollama run codellama` (first time and then you can just have application in background)
+- `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 -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.
+- Run with `ducky <path>` or `ducky <question>`
 
 ## 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.
+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
 
@@ -43,8 +36,16 @@ Install through [pypi](https://pypi.org/project/rubber-ducky/):
 ### Simple run
 `ducky`
 
-### To use additional options:
+or 
+
+`ducky <question>`
+
+or 
+
+`ducky -f <path>`
+
 
+### All options
 `ducky --file <path> --prompt <prompt> --directory <directory> --chain --model <model>`
 
 Where:

rubber_ducky-1.1.2/rubber_ducky.egg-info/entry_points.txt

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

rubber_ducky-1.1.2/rubber_ducky.egg-info/requires.txt

@@ -0,0 +1 @@
+ollama

{rubber-ducky-1.1.0 → rubber_ducky-1.1.2}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as f:
 
 setup(
     name='rubber-ducky',
-    version='1.1.0',
+    version='1.1.2',
     description='AI Companion for Pair Programming',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -15,12 +15,11 @@ setup(
     license='MIT',
     packages=find_packages(),
     install_requires=[
-        'langchain',
-        'termcolor'
+        'ollama',
     ],
     entry_points={
         'console_scripts': [
-            'ducky=ducky:ducky',
+            'ducky=ducky.ducky:main',
         ],
     },
 )

rubber-ducky-1.1.0/README.md

@@ -1,46 +0,0 @@
-# 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/ducky/ducky.py

@@ -1,96 +0,0 @@
-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
-
-
-        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 reads all the files from a directory and returns the concatenated string.
-
-    Args:
-        directory (str): The directory to be processed.
-
-    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
-
-
-def ducky() -> None:
-    """
-    This function parses the command line arguments and calls the Ollama model.
-    """
-    parser = argparse.ArgumentParser()
-    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()
-        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/rubber_ducky.egg-info/entry_points.txt

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

rubber-ducky-1.1.0/rubber_ducky.egg-info/requires.txt

@@ -1,2 +0,0 @@
-langchain
-termcolor