scriptmonkey 1.0.0__tar.gz → 1.0.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scriptmonkey
-Version: 1.0.0
+Version: 1.0.2
 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
@@ -30,6 +30,12 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
 
+## 🚀 Watch the Demo
+
+[![ScriptMonkey Demo](https://img.youtube.com/vi/2zoCDlf0Zf8/maxresdefault.jpg)](https://youtu.be/2zoCDlf0Zf8)
+
+Click the image above or watch the video directly on [YouTube](https://youtu.be/2zoCDlf0Zf8).
+
 ## Installation
 
 To install ScriptMonkey, simply run:

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

@@ -11,6 +11,12 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
 
+## 🚀 Watch the Demo
+
+[![ScriptMonkey Demo](https://img.youtube.com/vi/2zoCDlf0Zf8/maxresdefault.jpg)](https://youtu.be/2zoCDlf0Zf8)
+
+Click the image above or watch the video directly on [YouTube](https://youtu.be/2zoCDlf0Zf8).
+
 ## Installation
 
 To install ScriptMonkey, simply run:

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

@@ -1,6 +1,13 @@
 import sys
 import traceback
-from .openai_client import chatgpt_json, chatgpt, ScriptMonkeyResponse, ProjectStructureResponse, ProjectFile, default_prompts
+from .openai_client import (
+    chatgpt_json,
+    chatgpt,
+    ScriptMonkeyResponse,
+    ProjectStructureResponse,
+    ProjectFile,
+    default_prompts,
+)
 from .openai_client.prompting import load_prompt
 from .file_handler import read_file, write_file
 import platform
@@ -13,11 +20,13 @@ from pprint import pprint
 import os
 import platform
 
+
 def get_platform():
     os_name = platform.system()
     os_version = platform.release()
     return f"# Operating System: {os_name}, Version: {os_version}\n\n"
 
+
 class Spinner:
     def __init__(self, message="Processing"):
         self.spinner = itertools.cycle(["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"])
@@ -41,6 +50,7 @@ class Spinner:
         self.stop_running.set()
         self.spin_thread.join()
 
+
 def codemonkey_exception_handler(exc_type, exc_value, exc_traceback):
     if issubclass(exc_type, KeyboardInterrupt):
         sys.__excepthook__(exc_type, exc_value, exc_traceback)
@@ -77,37 +87,40 @@ def run():
 
 # - - - - - API KEY MANAGEMENT - - - - -
 
+
 def save_api_key(api_key: str):
     """Save the OpenAI API key to the configuration file and environment variable."""
-    with open(CONFIG_FILE, 'w') as file:
+    with open(CONFIG_FILE, "w") as file:
         file.write(api_key)
-    os.environ['OPENAI_API_KEY'] = api_key
+    os.environ["OPENAI_API_KEY"] = api_key
     print(f"✅ OpenAI API key saved to {CONFIG_FILE}.")
 
+
 def get_openai_api_key() -> str:
     """Retrieve the OpenAI API key from environment or configuration file."""
-    api_key = os.getenv('OPENAI_API_KEY')
-    
+    api_key = os.getenv("OPENAI_API_KEY")
+
     if not api_key:
         # Check for API key in the configuration file
         if os.path.exists(CONFIG_FILE):
-            with open(CONFIG_FILE, 'r') as file:
+            with open(CONFIG_FILE, "r") as file:
                 api_key = file.read().strip()
 
     # 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): ")
-        
+
         if api_key:
             save_api_key(api_key)
-    
+
     if not api_key:
         print("❌ No API key provided. Exiting ScriptMonkey.")
         sys.exit(1)
-    
+
     return api_key
 
+
 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): ")
@@ -117,8 +130,10 @@ def update_api_key():
     else:
         print("❌ No API key provided. The API key was not updated.")
 
+
 # - - - - - NEW FEATURES - - - - -
 
+
 def get_multiline_input_with_editor() -> str:
     """
     Opens the user's default text editor for entering multi-line input.
@@ -127,17 +142,17 @@ def get_multiline_input_with_editor() -> str:
     """
     with tempfile.NamedTemporaryFile(suffix=".txt") as temp_file:
         # Detect the editor from the environment or default based on the OS
-        editor = os.environ.get('EDITOR')
+        editor = os.environ.get("EDITOR")
 
         # If no editor is set, choose a default based on the platform
         if not editor:
-            if platform.system() == 'Windows':
-                editor = 'notepad'
+            if platform.system() == "Windows":
+                editor = "notepad"
             else:
-                editor = 'nano'  # Default for Unix-like systems
+                editor = "nano"  # Default for Unix-like systems
 
         # Adjust instructions based on the detected editor
-        if 'vim' in editor.lower():
+        if "vim" in editor.lower():
             instructions = (
                 "!# 🐒 Welcome to ScriptMonkey's project generator!\n"
                 "!# Please describe your project in detail below.\n"
@@ -145,21 +160,21 @@ def get_multiline_input_with_editor() -> str:
                 "!# type ':wq' to save and exit.\n"
                 "!# (Lines starting with '!#' will be ignored.)\n\n"
             )
-        elif 'nano' in editor.lower():
+        elif "nano" in editor.lower():
             instructions = (
                 "!# 🐒 Welcome to ScriptMonkey's project generator!\n"
                 "!# Please describe your project in detail below.\n"
                 "!# When you're done, press 'Ctrl+O' to save and 'Ctrl+X' to exit.\n"
                 "!# (Lines starting with '!#' will be ignored.)\n\n"
             )
-        elif 'notepad' in editor.lower():
+        elif "notepad" in editor.lower():
             instructions = (
                 "!# 🐒 Welcome to ScriptMonkey's project generator!\n"
                 "!# Please describe your project in detail below.\n"
                 "!# When you're done, save and close the Notepad window.\n"
                 "!# (Lines starting with '!#' will be ignored.)\n\n"
             )
-        elif 'code' in editor.lower():
+        elif "code" in editor.lower():
             instructions = (
                 "!# 🐒 Welcome to ScriptMonkey's project generator!\n"
                 "!# Please describe your project in detail below.\n"
@@ -175,7 +190,7 @@ def get_multiline_input_with_editor() -> str:
             )
 
         # Write the instructions to the temporary file
-        temp_file.write(instructions.encode('utf-8'))
+        temp_file.write(instructions.encode("utf-8"))
         temp_file.flush()
 
         # Open the temporary file in the detected editor
@@ -183,11 +198,12 @@ def get_multiline_input_with_editor() -> str:
 
         # Read the user's input, ignoring lines starting with '!#'
         temp_file.seek(0)
-        user_input = temp_file.read().decode('utf-8')
+        user_input = temp_file.read().decode("utf-8")
         user_input = "\n".join(line for line in user_input.splitlines() if not line.startswith("!#"))
 
     return user_input.strip()
 
+
 def generate_project_structure(description: str) -> ProjectStructureResponse:
     """Generates the project structure based on the user's project description using OpenAI."""
     instructions = (
@@ -206,57 +222,93 @@ def generate_project_structure(description: str) -> ProjectStructureResponse:
 
     # Call the chatgpt_json function to get structured project plan
     project_structure = chatgpt_json(
-        instructions=instructions, 
-        content=description, 
-        response_format=ProjectStructureResponse
+        instructions=instructions, content=description, response_format=ProjectStructureResponse
     )
-    
+
     return project_structure
 
-def create_project_structure(project_structure_response: dict, base_directory: str = "./generated_project"):
-    """Creates the directories and files for the project and generates code content for code files."""
-    for project_file in project_structure_response['files']:
-        file_path = os.path.join(base_directory, project_file['path'].lstrip('/'))
+
+def create_project_structure(
+    project_structure_response: dict, project_description: str, base_directory: str = "./generated_project"
+):
+    """Creates the directories and files for the project and generates code content for all file types."""
+    # Extract the list of project files for context
+    project_files = project_structure_response["files"]
+
+    # Iterate through each file in the project structure
+    for project_file in project_files:
+        file_path = os.path.join(base_directory, project_file["path"].lstrip("/"))
 
         # Check if it's a directory or file (directories end with '/')
-        if file_path.endswith('/'):
+        if file_path.endswith("/"):
             os.makedirs(file_path, exist_ok=True)
             print(f"🐒 ScriptMonkey created directory: {file_path}")
         else:
             os.makedirs(os.path.dirname(file_path), exist_ok=True)
 
-            # If it's a Python code file, generate code and write to the file
-            if file_path.endswith('.py'):
-                generated_code = generate_code_for_file(project_file)
-                if not os.path.exists(file_path):
-                    with open(file_path, 'w') as f:
-                        f.write(generated_code)
-                    print(f"🐒 ScriptMonkey created file with generated code at: '{file_path}'.")
-                else:
-                    print(f"File already exists, skipping: {file_path}")
+            # Generate content for all files, including Python, HTML, JSON, CSS, etc.
+            generated_content = generate_code_for_file(project_file, project_description, project_files)
+
+            # Write the generated content to the file if it doesn't already exist
+            if not os.path.exists(file_path):
+                with open(file_path, "w") as f:
+                    f.write(generated_content)
+                print(f"🐒 ScriptMonkey created file with generated content at: '{file_path}'.")
             else:
-                # Create other file types (HTML, CSS, etc.)
-                if not os.path.exists(file_path):
-                    with open(file_path, 'w') as f:
-                        pass  # Create an empty file for non-code files
-                    print(f"🐒 ScriptMonkey reated file: {file_path}")
-                else:
-                    print(f"File already exists, skipping: {file_path}")
+                print(f"File already exists, skipping: {file_path}")
 
 
-def generate_code_for_file(file_description: dict) -> str:
-    """Generates code content for a given file based on its description using the chatgpt() function."""
+def gather_project_context(project_description: str, project_files: list) -> str:
+    """
+    Gathers a summary of the project goal and all existing files with their key functions or classes.
+
+    Args:
+        project_description (str): A high-level description of the project's purpose and goals.
+        project_files (list): List of project file descriptions.
+
+    Returns:
+        str: A summary of the project goal and existing modules, classes, and functions.
+    """
+    context = f"Project Goal: {project_description}\n\n"
+    context += "Project Context:\n"
+    for file in project_files:
+        if file["functions"]:
+            context += f"- In '{file['path']}', the following functions are defined:\n"
+            for function in file["functions"]:
+                context += f"  - {function['function_name']}: {function['description']} (Inputs: {function['inputs']}, Outputs: {function['outputs']})\n"
+        else:
+            context += f"- '{file['path']}' is defined with no specific functions listed.\n"
+    return context
+
+
+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.
+
+    Args:
+        file_description (dict): The description of the file for which code 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.
+    """
+    # 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
     instructions = (
-        "Write the complete Python code based on the following file description without adding any additional commentary or explanation. "
-        "Ensure the code follows PEP8 standards, includes type hints, and contains relevant docstrings."
+        "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"\n\nFile Description: {file_description['description']}"
+        f"\n\n{context}\n"
     )
 
     # Check if the file has functions to include in the code
-    if file_description.get('functions'):
+    if file_description.get("functions"):
         instructions += "\n\nFunctions:\n"
-        for function in file_description['functions']:
+        for function in file_description["functions"]:
             instructions += (
                 f"- {function['function_name']}: {function['description']} "
                 f"(Inputs: {function['inputs']}, Outputs: {function['outputs']})\n"
@@ -264,13 +316,14 @@ def generate_code_for_file(file_description: dict) -> str:
 
     # Call the chatgpt function to generate the code
     generated_code = 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()
-    
+
     return generated_code
 
+
 def generate_readme(description: str, project_structure: dict) -> str:
     """Generates a README.md content based on the project description and structure."""
     instructions = (
@@ -287,9 +340,8 @@ def generate_readme(description: str, project_structure: dict) -> str:
     return readme_content
 
 
-# Example usage
 def main():
-    if len(sys.argv) > 1 and sys.argv[1] == '--set-api-key':
+    if len(sys.argv) > 1 and sys.argv[1] == "--set-api-key":
         update_api_key()
     else:
         print(f"\n- - 🐒 WELCOME TO SCRIPT MONKEY 🐒 - - -\n")
@@ -299,7 +351,9 @@ def main():
         # Step 1: Get multi-line project description from user
         project_description = get_multiline_input_with_editor()
         if not project_description:
-            print(f"\nNo Project Description Provided (Tip: Did you save before closing the editor?).\n🐒 Quitting ScriptMonkey...")
+            print(
+                f"\nNo Project Description Provided (Tip: Did you save before closing the editor?).\n🐒 Quitting ScriptMonkey..."
+            )
             exit()
         print(f"Project Description: {project_description}")
 
@@ -310,12 +364,12 @@ def main():
 
         # Step 3: Create the project structure (directories and files) on the filesystem
         print(f"\n🐒 ScriptMonkey is coding...")
-        create_project_structure(project_structure)
+        create_project_structure(project_structure_response=project_structure, project_description=project_description)
         print("\nProject structure creation complete.")
 
         # Step 4: Generate the README.md content based on the project description and structure
         readme_content = generate_readme(project_description, project_structure)
         readme_path = "./generated_project/README.md"
-        with open(readme_path, 'w') as readme_file:
+        with open(readme_path, "w") as readme_file:
             readme_file.write(readme_content)
-        print(f"🐒 ScriptMonkey wrote a README.md file at: '{readme_path}'")
+        print(f"🐒 ScriptMonkey wrote a README.md file at: '{readme_path}'")

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scriptmonkey
-Version: 1.0.0
+Version: 1.0.2
 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
@@ -30,6 +30,12 @@ ScriptMonkey is an AI-powered Python package that reimagines how projects are bu
 - **Code Auto-Correction**: Automatically updates your Python files with the fixes.
 - **Cross-IDE Compatibility**: Works with any IDE or code editor.
 
+## 🚀 Watch the Demo
+
+[![ScriptMonkey Demo](https://img.youtube.com/vi/2zoCDlf0Zf8/maxresdefault.jpg)](https://youtu.be/2zoCDlf0Zf8)
+
+Click the image above or watch the video directly on [YouTube](https://youtu.be/2zoCDlf0Zf8).
+
 ## Installation
 
 To install ScriptMonkey, simply run:

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

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="scriptmonkey",
-    version="1.0.0",
+    version="1.0.2",
     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",
@@ -48,4 +48,4 @@ setup(
     ],
     package_data={"scriptmonkey.openai_client": ["prompts/*.txt"]},
     include_package_data=True,
-)
+)