Modifications to code generation match current state of main repo.

Author: pydn

LICENSE

@@ -1,7 +1,6 @@
 The MIT License (MIT)
 
 Copyright (c) 2023 Peyton DeNiro
-Copyright (c) 2024 Anthony Maranto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,117 +1,5 @@
-**Status: Fork in development**. It works on my machine. It might not on yours.
-Let me know of any major issues by submitting an Issue.
-I plan to do some fresh install testing when I have time.
-
-## ComfyUI-SaveAsScript
-
-ComfyUI-SaveAsScript (or SaS) is a fork of [ComfyUI-To-Python-Extension](https://github.com/pydn/ComfyUI-to-Python-Extension). It provides a more robust command-line interface and the ability to export your current workflow as a script directly from a button on the ComfyUI web interface.
-
-Once exported, this script can be run to run the workflow without a frontend, or it can be imported and the `main()` function can be used to call the workflow programatically.
-
-### New Feauture: Module Support
-
-Now, scripts exported with SaS can be imported as modules! Once you have a script exported, you can use it like:
-```python
->>> import exported_script
->>> results = exported_script.main("A prompt that would be sent to the command-line arguments", queue_size=1)
-```
-
-The first `SaveImage` node reached will instead *return* the output to the calling function. 
-
-### New Feature: Custom Output Path
-
-When running the exported script normally, you can now specify an `--output` option that will override the default path of `SaveImage` nodes.
-If only a single image is exported by the node, then the path will be used verbatim. Otherwise, the path will be used as a prefix, and `_#####.png` will be appended
-to ensure uniqueness. Note that files *will be clobbered* if only one image is exported.
-If the path is a directory, the `SaveImage` node's `filename_prefix` will be used.
-
-If `-` is selected as the output path, normal ComfyUI output will be piped to stderr and the resultant image will be piped to stdout, allowing one to use the script
-like:
-```bash
-python3 script.py "A painting of outer space" --output - --queue-size 1 > image.png
-```
-
-### Usage (Web)
-
-Upon installation, there will be a button labeled "Save as Script" on the interface, pictured below:
-
-![A button that exports the current script on the ComfyUI](images/save_as_script.png)
-
-Click that button and enter your preferred name for the downloaded script (extension added automatically), and your file will be downloaded.
-
-Note that if you use the script this way, you do **not** need to enable developer mode. You *will* if you use the CLI (to get the API JSON).
-
-### Usage (CLI)
-
-Navigating to the extension directory, you can also use the basic CLI included in the script to save your script without changing the Python file.
-
-```bash
-usage: comfyui_to_python.py [-h] [--output OUTPUT] [--queue-size QUEUE_SIZE] [--yes] workflow
-
-Converts a ComfyUI-style workflow.json file to a Python file. Must have been exported with API calls
-
-positional arguments:
-  workflow              The workflow.json file to convert
-
-options:
-  -h, --help            show this help message and exit
-  --output OUTPUT, -o OUTPUT
-                        The output file (defaults to [input file].py)
-  --queue-size QUEUE_SIZE, -q QUEUE_SIZE
-                        The queue size per run
-  --yes, --overwrite, -y
-                        Overwrite the output file if it exists
-```
-
-### Arguments
-
-It is now possible to pass command-line arguments to a generated script file. Any time a **required** input variable for *any* node in your the ComfyUI workflow is left unfilled, SaveAsScript will automatically convert that node into an argument.
-
-For instance, if you have a simple default workflow, but have converted the text widget of the positive prompt into an input and left it unfilled like so:
-
-![An altered version of the default ComfyUI workflow](images/default_altered.png)
-
-Then the unfilled required variable will be available as an argument:
-```bash
-usage: default.py [-h] [--queue-size QUEUE_SIZE] [--comfyui-directory COMFYUI_DIRECTORY] text1
-
-A converted ComfyUI workflow. Required inputs listed below. Values passed should be valid JSON (assumes string if not valid JSON).
-
-positional arguments:
-  text1                 Argument 0, input `text` for node "CLIP Text Encode (Prompt)" id 6 (autogenerated)
-
-options:
-  -h, --help            show this help message and exit
-  --queue-size QUEUE_SIZE, -q QUEUE_SIZE
-                        How many times the workflow will be executed (default: 1)
-  --comfyui-directory COMFYUI_DIRECTORY, -c COMFYUI_DIRECTORY
-                        Where to look for ComfyUI (default: current directory)
-  --output OUTPUT, -o OUTPUT
-                        The location to save the output image. Either a file path, a directory, or - for stdout (default: the ComfyUI output directory)
-  --disable-metadata    Disables writing workflow metadata to the outputs
-```
-
-Arguments are new. **If you have any suggestions on how to improve them or on how to effectively specify defaults in the workflow and override in the command-line**, feel free to suggest that in an Issue.
-
-#### Passing Arguments to ComfyUI
-
-In case you want to pass anything to the ComfyUI server as an argument, you can use `--` to indicate you're done with SaS arguments and are now passing ComfyUI arguments.
-For instance:
-
-```bash
-python3 script.py "A painting of outer space" --queue-size 1 -- --cpu
-```
-
-### Other Changes
-
-#### Bugfixes
-- Windows paths are now properly escaped.
-- I also fixed what seemed to be a minor bug with exporting certain Crystools nodes, possibly due to their unusual name.
-
-#### TODO
-- Improve compatibility with module API
-
-## Old Description of ComfyUI-to-Python-Extension (usage altered)
+## ComfyUI-to-Python-Extension
+![banner](images/comfyui_to_python_banner.png)
 
 The `ComfyUI-to-Python-Extension` is a powerful tool that translates [ComfyUI](https://github.com/comfyanonymous/ComfyUI) workflows into executable Python code. Designed to bridge the gap between ComfyUI's visual interface and Python's programming environment, this script facilitates the seamless transition from design to code execution. Whether you're a data scientist, a software developer, or an AI enthusiast, this tool streamlines the process of implementing ComfyUI workflows in Python.
 
@@ -236,10 +124,63 @@ if __name__ == "__main__":
 ## Usage
 
 
-1. Install the custom_node (via git cloning or the Manager)
-
-2. Click the button in the web UI OR run the CLI
-
-3. Move the created .py file to your `ComfyUI` folder
-
-4. Run the generated script!
+1. Navigate to your `ComfyUI` directory
+
+2. Clone this repo
+    ```bash
+    git clone https://github.com/pydn/ComfyUI-to-Python-Extension.git
+    ```
+
+    After cloning the repo, your `ComfyUI` directory should look like this:
+    ```
+    /comfy
+    /comfy_extras
+    /ComfyUI-to-Python-Extension
+    /custom_nodes
+    /input
+    /models
+    /output
+    /script_examples
+    /web
+    .gitignore
+    LICENSE
+    README.md
+    comfyui_screenshot.png
+    cuda_mollac.py
+    execution.py
+    extra_model_paths.yaml.example
+    folder_paths.py
+    latent_preview.py
+    main.py
+    nodes.py
+    requirements.txt
+    server.py
+    ```
+
+3. Navigate to the `ComfyUI-to-Python-Extension` folder and install requirements
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+4. Launch ComfyUI, click the gear icon over `Queue Prompt`, then check `Enable Dev mode Options`. **THE SCRIPT WILL NOT WORK IF YOU DO NOT ENABLE THIS OPTION!**
+
+![Enable Dev Mode Options](images/dev_mode_options.jpg)
+
+5. Load up your favorite workflows, then click the newly enabled `Save (API Format)` button under Queue Prompt
+
+6. Move the downloaded .json workflow file to your `ComfyUI/ComfyUI-to-Python-Extension` folder
+
+7. If needed, add arguments when executing `comfyui_to_python.py` to update the default `input_file` and `output_file` to match your .json workflow file and desired .py file name. By default, the script will look for a file called `workflow_api.json`. You can also update the `queue_size` variable to your desired number of images that you want to generate in a single script execution. By default, the scripts will generate 10 images. Run `python comfyui_to_python.py --help` for more details.
+
+8a. Run the script with default arguments:
+   ```bash
+   python comfyui_to_python.py
+   ```
+8b. Run the script with optional arguments:
+   ```bash
+   python comfyui_to_python.py --input_file "workflow_api (2).json" --output_file my_workflow.py --queue_size 100
+   ```
+
+9. After running `comfyui_to_python.py`, a new .py file will be created in the current working directory. If you made no changes, look for `workflow_api.py`.
+
+10. Now you can execute the newly created .py file to generate images without launching a server.

__init__.py

@@ -17,7 +17,10 @@
     print("Installing...")
 
     import importlib
-    spec = importlib.util.spec_from_file_location('impact_install', os.path.join(os.path.dirname(__file__), 'install.py'))
+
+    spec = importlib.util.spec_from_file_location(
+        "impact_install", os.path.join(os.path.dirname(__file__), "install.py")
+    )
     impact_install = importlib.util.module_from_spec(spec)
     spec.loader.exec_module(impact_install)
 
@@ -35,19 +38,20 @@
 WEB_DIRECTORY = "js"
 NODE_CLASS_MAPPINGS = {}
 
+
 @server.PromptServer.instance.routes.post("/saveasscript")
 async def save_as_script(request):
     try:
         data = await request.json()
-        name = data['name']
-        workflow = data['workflow']
-        
+        name = data["name"]
+        workflow = data["workflow"]
+
         sio = StringIO()
         ComfyUItoPython(workflow=workflow, output_file=sio)
-        
+
         sio.seek(0)
         data = sio.read()
-        
+
         return web.Response(text=data, status=200)
     except Exception as e:
         traceback.print_exc()