scriptmonkey 1.0.2__tar.gz → 1.2.0__tar.gz

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scriptmonkey
-Version: 1.0.2
+Version: 1.2.0
 Summary: A Python package that generates complex Python projects and fixes errors in your code using OpenAI's GPT API.
 Home-page: https://github.com/lukerbs/ScriptMonkey
 Author: Luke Kerbs
@@ -16,6 +16,7 @@ Requires-Dist: openai
 Requires-Dist: pydantic
 Requires-Dist: tqdm
 Requires-Dist: python-dotenv
+Requires-Dist: rich
 
 
 # ScriptMonkey 🐒
@@ -29,6 +30,7 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **AI-Powered Fixes**: Uses OpenAI's GPT API to understand and resolve errors.
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
+- **Context-Aware Q&A**: Ask questions directly to ChatGPT with or without providing files for context. Get detailed answers with code examples, explanations, and best practices tailored to your needs.
 
 ## 🚀 Watch the Demo
 
@@ -46,7 +48,7 @@ pip install scriptmonkey
 
 ## Usage
 
-### Project Generation with `python3 -m scriptmonkey`
+### Project Generation with `scriptmonkey`
 
 ScriptMonkey can generate a complete, custom-coded project structure based on a description you provide. This feature helps you quickly set up new projects with the necessary files and folders.
 
@@ -55,7 +57,7 @@ ScriptMonkey can generate a complete, custom-coded project structure based on a
 1. Run the following command in your terminal:
 
    ```bash
-   python3 -m scriptmonkey
+   scriptmonkey
    ```
 
 2. A text editor will open (e.g., `nano`, `vim`, or `notepad` depending on your environment). Follow the on-screen instructions to provide a detailed description of your project.
@@ -80,6 +82,26 @@ I need a Flask-based web application for managing a book library. The applicatio
 
 ScriptMonkey will use this description to create a project structure and code files for you in a directory named `generated_project`.
 
+### Context-Aware Q&A with `scriptmonkey --ask`
+
+ScriptMonkey can help answer your technical questions, whether or not you provide code files for context. This feature allows you to leverage the power of ChatGPT to ask questiona about files, clarify concepts, get code reviews, or understand best practices in various programming languages.
+
+#### How to Use
+
+- **Ask a question without files**:
+
+  ```bash
+  scriptmonkey --ask "What are the best practices for database indexing?"
+  ```
+
+- **Ask a question with files**:
+
+  ```bash
+  scriptmonkey --ask "Can you help me optimize this function?" --files ./path/to/file1.py ./path/to/file2.js
+  ```
+
+  ScriptMonkey will analyze your question and any provided files to give a detailed, markdown-formatted response with explanations and code suggestions, if applicable. This feature is great for in-depth guidance on code optimization, architecture, or general programming questions.
+
 ### Error Handling with `scriptmonkey.run()`
 
 ScriptMonkey doesn't just build projects; it also makes debugging a breeze.

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/README.md

@@ -10,6 +10,7 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **AI-Powered Fixes**: Uses OpenAI's GPT API to understand and resolve errors.
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
+- **Context-Aware Q&A**: Ask questions directly to ChatGPT with or without providing files for context. Get detailed answers with code examples, explanations, and best practices tailored to your needs.
 
 ## 🚀 Watch the Demo
 
@@ -27,7 +28,7 @@ pip install scriptmonkey
 
 ## Usage
 
-### Project Generation with `python3 -m scriptmonkey`
+### Project Generation with `scriptmonkey`
 
 ScriptMonkey can generate a complete, custom-coded project structure based on a description you provide. This feature helps you quickly set up new projects with the necessary files and folders.
 
@@ -36,7 +37,7 @@ ScriptMonkey can generate a complete, custom-coded project structure based on a
 1. Run the following command in your terminal:
 
    ```bash
-   python3 -m scriptmonkey
+   scriptmonkey
    ```
 
 2. A text editor will open (e.g., `nano`, `vim`, or `notepad` depending on your environment). Follow the on-screen instructions to provide a detailed description of your project.
@@ -61,6 +62,26 @@ I need a Flask-based web application for managing a book library. The applicatio
 
 ScriptMonkey will use this description to create a project structure and code files for you in a directory named `generated_project`.
 
+### Context-Aware Q&A with `scriptmonkey --ask`
+
+ScriptMonkey can help answer your technical questions, whether or not you provide code files for context. This feature allows you to leverage the power of ChatGPT to ask questiona about files, clarify concepts, get code reviews, or understand best practices in various programming languages.
+
+#### How to Use
+
+- **Ask a question without files**:
+
+  ```bash
+  scriptmonkey --ask "What are the best practices for database indexing?"
+  ```
+
+- **Ask a question with files**:
+
+  ```bash
+  scriptmonkey --ask "Can you help me optimize this function?" --files ./path/to/file1.py ./path/to/file2.js
+  ```
+
+  ScriptMonkey will analyze your question and any provided files to give a detailed, markdown-formatted response with explanations and code suggestions, if applicable. This feature is great for in-depth guidance on code optimization, architecture, or general programming questions.
+
 ### Error Handling with `scriptmonkey.run()`
 
 ScriptMonkey doesn't just build projects; it also makes debugging a breeze.

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/scriptmonkey/core.py

@@ -1,5 +1,6 @@
 import sys
 import traceback
+import argparse
 from .openai_client import (
     chatgpt_json,
     chatgpt,
@@ -20,6 +21,15 @@ from pprint import pprint
 import os
 import platform
 
+import re
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.syntax import Syntax
+
+console = Console()
+
+CONFIG_FILE = os.path.expanduser("~/.scriptmonkey_config")
+
 
 def get_platform():
     os_name = platform.system()
@@ -109,7 +119,7 @@ def get_openai_api_key() -> str:
     # Prompt user for API key if not found
     if not api_key:
         print("🐒 ScriptMonkey requires an OpenAI API key to function.")
-        api_key = getpass.getpass("Please enter your OpenAI API key (input hidden): ")
+        api_key = input("Please enter your OpenAI API key: ")
 
         if api_key:
             save_api_key(api_key)
@@ -123,7 +133,7 @@ def get_openai_api_key() -> str:
 
 def update_api_key():
     """Prompt the user to update the OpenAI API key."""
-    api_key = getpass.getpass("Enter the new OpenAI API key (input hidden): ")
+    api_key = input("Enter the new OpenAI API key: ")
     if api_key:
         save_api_key(api_key)
         print("✅ OpenAI API key updated successfully.")
@@ -283,29 +293,39 @@ def gather_project_context(project_description: str, project_files: list) -> str
 
 def generate_code_for_file(file_description: dict, project_description: str, project_files: list) -> str:
     """
-    Generates code content for a given file based on its description using the chatgpt() function.
+    Generates content for a given file based on its description using the chatgpt() function.
 
     Args:
-        file_description (dict): The description of the file for which code is being generated.
+        file_description (dict): The description of the file for which content is being generated.
         project_description (str): A high-level description of the project's purpose and goals.
         project_files (list): List of all project files for context.
 
     Returns:
-        str: The generated Python code.
+        str: The generated content for the file.
     """
     # Gather context about the project goal and other files
     context = gather_project_context(project_description, project_files)
 
-    # Prepare instructions for OpenAI to generate code based on the file description
+    # Extract the file extension to inform the content type
+    file_extension = os.path.splitext(file_description["path"])[1].lower().strip(".")
+
+    # Dynamically adjust the content type description based on the file extension
+    if file_extension:
+        content_type_description = f"{file_extension.upper()} file content"
+    else:
+        content_type_description = "text content"
+
+    # Prepare instructions for OpenAI to generate content based on the file description and type
     instructions = (
-        "Write the complete Python code for the following file, considering the context of the entire project. "
-        "Use relevant imports and cross-file references where necessary. Do not add extra commentary or explanation."
-        "\nEnsure the code follows PEP8 standards, includes type hints, and contains relevant docstrings."
+        f"Write the complete content for a {content_type_description} that fulfills the following requirements. "
+        "Consider the context of the entire project when generating the content and make use of imports where available and appropriate."
+        "Use relevant imports, references, and appropriate formatting or structure where necessary. Do not add extra commentary or explanation. "
+        "Make sure to return the content directly, without wrapping it in any code fences like triple quotes or backticks."
         f"\n\nFile Description: {file_description['description']}"
         f"\n\n{context}\n"
     )
 
-    # Check if the file has functions to include in the code
+    # Include functions for code files (if provided)
     if file_description.get("functions"):
         instructions += "\n\nFunctions:\n"
         for function in file_description["functions"]:
@@ -314,14 +334,14 @@ def generate_code_for_file(file_description: dict, project_description: str, pro
                 f"(Inputs: {function['inputs']}, Outputs: {function['outputs']})\n"
             )
 
-    # Call the chatgpt function to generate the code
-    generated_code = chatgpt(prompt=instructions)
+    # Call the chatgpt function to generate the content
+    generated_content = chatgpt(prompt=instructions)
 
-    # Strip out any unintended extra explanations that might still slip through
-    if "```python" in generated_code:
-        generated_code = generated_code.split("```python")[1].split("```")[0].strip()
+    # Clean up any unintended code blocks
+    if f"```{file_extension}" in generated_content:
+        generated_content = generated_content.split(f"```{file_extension}")[1].split("```")[0].strip()
 
-    return generated_code
+    return generated_content
 
 
 def generate_readme(description: str, project_structure: dict) -> str:
@@ -340,11 +360,107 @@ def generate_readme(description: str, project_structure: dict) -> str:
     return readme_content
 
 
+def ask_gpt_with_files(question, file_paths):
+    """
+    Constructs a detailed and flexible prompt for ChatGPT using a question and optionally including content from specified files.
+    """
+    prompt = (
+        f"### Question:\n"
+        f"{question}\n\n"
+        "If I have included any files below, you can use them for additional context for this question. "
+        "Please analyze the provided files below (if available) as needed and reference them when forming your answer. "
+        "If the answer involves code, please format any code examples using Markdown with properly labeled language-specific code blocks. "
+        "Your response should be in Markdown format to preserve readability.\n\n"
+    )
+
+    if file_paths:
+        prompt += "### Files Provided:\n"
+        for path in file_paths:
+            try:
+                content = read_file(path)
+                prompt += (
+                    f"## File: {path}\n"
+                    f"The content of the file '{path}' is included below. Use this as context for answering the question:\n\n"
+                    f"```\n{content}\n```\n\n"
+                )
+            except FileNotFoundError:
+                console.print(f"[bold yellow]Warning: {path} not found. Skipping this file.[/bold yellow]")
+            except Exception as e:
+                console.print(f"[bold red]Error reading {path}: {e}[/bold red]")
+
+    else:
+        prompt += (
+            "No specific files have been provided, so please base your response solely on the question above. "
+            "If the response includes any code examples or technical explanations, please use Markdown formatting with language-specific code blocks for clarity.\n"
+        )
+
+    # Output the constructed prompt to the console for transparency
+    console.rule("🐒 ScriptMonkey is Thinking 🐒")
+    console.rule()
+
+    # Use the OpenAI API to get a response
+    try:
+        response = chatgpt(prompt=prompt)
+        # Display the response using rich markdown and detect code blocks
+        console.rule("🐒 ScriptMonkey Response 🐒")
+        render_response_with_syntax_highlighting(response)
+        console.print("\n")
+        console.rule()
+    except Exception as e:
+        console.print(f"[bold red]Error using OpenAI API: {e}[/bold red]")
+
+
+def render_response_with_syntax_highlighting(response):
+    """
+    Render a ChatGPT response with syntax highlighting for detected code blocks.
+    """
+    # Regular expression to detect code blocks with a specified language (e.g., ```python)
+    code_block_pattern = re.compile(r"```(\w+)?\n(.*?)```", re.DOTALL)
+    last_pos = 0
+
+    # Iterate over all detected code blocks
+    for match in code_block_pattern.finditer(response):
+        language = match.group(1) or "text"  # Default to 'text' if no language is specified
+        code_content = match.group(2)
+
+        # Print any text before the code block as markdown
+        if match.start() > last_pos:
+            pre_text = response[last_pos : match.start()]
+            console.print(Markdown(pre_text))
+
+        # Print the code block with syntax highlighting
+        syntax = Syntax(code_content, language, theme="monokai", line_numbers=True)
+        console.print("\n")
+        console.print(syntax)
+        console.print("\n")
+
+        last_pos = match.end()
+
+    # Print any remaining text after the last code block
+    if last_pos < len(response):
+        console.print(Markdown(response[last_pos:]))
+
+
 def main():
-    if len(sys.argv) > 1 and sys.argv[1] == "--set-api-key":
+    parser = argparse.ArgumentParser(description="ScriptMonkey - Generate Python projects and fix code.")
+    parser.add_argument("--ask", help="Ask a question to ChatGPT", type=str)
+    parser.add_argument("--files", nargs="*", help="Paths to files to include in the prompt", type=str)
+    parser.add_argument("--set-api-key", help="Set the OpenAI API key", action="store_true")
+    args = parser.parse_args()
+    print(f"\n- - 🐒 WELCOME TO SCRIPT MONKEY 🐒 - - -\n")
+
+    if args.set_api_key:
+        # Handle setting the API key
         update_api_key()
+        return
+
+    if args.ask:
+        # Handle the --ask functionality
+        question = args.ask
+        file_paths = args.files if args.files else []
+        ask_gpt_with_files(question, file_paths)
     else:
-        print(f"\n- - 🐒 WELCOME TO SCRIPT MONKEY 🐒 - - -\n")
+        # Original ScriptMonkey functionality
         print(f"Opening prompt editor... ")
         time.sleep(2)
 

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/scriptmonkey/openai_client/client.py

@@ -9,27 +9,29 @@ CONFIG_FILE = os.path.expanduser("~/.scriptmonkey_config")
 # Load environment variables from the .env file if present
 load_dotenv()
 
+
 def get_openai_api_key():
     # Try to get the API key from environment variables
     api_key = os.getenv("OPENAI_API_KEY")
-    
+
     # If not set, check the config file
     if not api_key and os.path.exists(CONFIG_FILE):
-        with open(CONFIG_FILE, 'r') as f:
+        with open(CONFIG_FILE, "r") as f:
             api_key = f.read().strip()
 
     # If still not set, prompt the user for it
     if not api_key:
         print("It looks like your OpenAI API key isn't set.")
         api_key = input("🐒 Please paste your OpenAI API key here and press ENTER: ").strip()
-        
+
         # Save the key to the config file for future use
-        with open(CONFIG_FILE, 'w') as f:
+        with open(CONFIG_FILE, "w") as f:
             f.write(api_key)
         print(f"Your API key has been saved to {CONFIG_FILE} for future use.")
 
     return api_key
 
+
 # Get the OpenAI API key using the function
 OPENAI_API_KEY = get_openai_api_key()
 

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/scriptmonkey.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scriptmonkey
-Version: 1.0.2
+Version: 1.2.0
 Summary: A Python package that generates complex Python projects and fixes errors in your code using OpenAI's GPT API.
 Home-page: https://github.com/lukerbs/ScriptMonkey
 Author: Luke Kerbs
@@ -16,6 +16,7 @@ Requires-Dist: openai
 Requires-Dist: pydantic
 Requires-Dist: tqdm
 Requires-Dist: python-dotenv
+Requires-Dist: rich
 
 
 # ScriptMonkey 🐒
@@ -29,6 +30,7 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **AI-Powered Fixes**: Uses OpenAI's GPT API to understand and resolve errors.
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
+- **Context-Aware Q&A**: Ask questions directly to ChatGPT with or without providing files for context. Get detailed answers with code examples, explanations, and best practices tailored to your needs.
 
 ## 🚀 Watch the Demo
 
@@ -46,7 +48,7 @@ pip install scriptmonkey
 
 ## Usage
 
-### Project Generation with `python3 -m scriptmonkey`
+### Project Generation with `scriptmonkey`
 
 ScriptMonkey can generate a complete, custom-coded project structure based on a description you provide. This feature helps you quickly set up new projects with the necessary files and folders.
 
@@ -55,7 +57,7 @@ ScriptMonkey can generate a complete, custom-coded project structure based on a
 1. Run the following command in your terminal:
 
    ```bash
-   python3 -m scriptmonkey
+   scriptmonkey
    ```
 
 2. A text editor will open (e.g., `nano`, `vim`, or `notepad` depending on your environment). Follow the on-screen instructions to provide a detailed description of your project.
@@ -80,6 +82,26 @@ I need a Flask-based web application for managing a book library. The applicatio
 
 ScriptMonkey will use this description to create a project structure and code files for you in a directory named `generated_project`.
 
+### Context-Aware Q&A with `scriptmonkey --ask`
+
+ScriptMonkey can help answer your technical questions, whether or not you provide code files for context. This feature allows you to leverage the power of ChatGPT to ask questiona about files, clarify concepts, get code reviews, or understand best practices in various programming languages.
+
+#### How to Use
+
+- **Ask a question without files**:
+
+  ```bash
+  scriptmonkey --ask "What are the best practices for database indexing?"
+  ```
+
+- **Ask a question with files**:
+
+  ```bash
+  scriptmonkey --ask "Can you help me optimize this function?" --files ./path/to/file1.py ./path/to/file2.js
+  ```
+
+  ScriptMonkey will analyze your question and any provided files to give a detailed, markdown-formatted response with explanations and code suggestions, if applicable. This feature is great for in-depth guidance on code optimization, architecture, or general programming questions.
+
 ### Error Handling with `scriptmonkey.run()`
 
 ScriptMonkey doesn't just build projects; it also makes debugging a breeze.

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/scriptmonkey.egg-info/requires.txt

@@ -2,3 +2,4 @@ openai
 pydantic
 tqdm
 python-dotenv
+rich

{scriptmonkey-1.0.2 → scriptmonkey-1.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="scriptmonkey",
-    version="1.0.2",
+    version="1.2.0",
     description="A Python package that generates complex Python projects and fixes errors in your code using OpenAI's GPT API.",
     long_description=open("README.md", "r").read(),
     long_description_content_type="text/markdown",
@@ -11,7 +11,7 @@ setup(
     author_email="LDK.kerbs@gmail.com",
     license="MIT",
     packages=find_packages(),
-    install_requires=["openai", "pydantic", "tqdm", "python-dotenv"],
+    install_requires=["openai", "pydantic", "tqdm", "python-dotenv", "rich"],
     python_requires=">=3.6",
     entry_points={
         "console_scripts": [