Modify the structure to be installable via pip and support new UI

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,58 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "pyproject.toml"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'ltdrdata' || github.repository_owner == 'Comfy-Org' }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+
+      - name: Get current version
+        id: current_version
+        run: |
+          CURRENT_VERSION=$(grep -oP 'version = "\K[^"]+' pyproject.toml)
+          echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+          echo "Current version: $CURRENT_VERSION"
+
+      - name: Build package
+        run: python -m build
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          files: dist/*
+          tag_name: v${{ steps.current_version.outputs.version }}
+          draft: false
+          prerelease: false
+          generate_release_notes: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}
+          skip-existing: true
+          verbose: true 

.github/workflows/publish.yml

@@ -14,7 +14,7 @@ jobs:
   publish-node:
     name: Publish Custom Node to registry
     runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'ltdrdata' }}
+    if: ${{ github.repository_owner == 'ltdrdata' || github.repository_owner == 'Comfy-Org' }}
     steps:
       - name: Check out code
         uses: actions/checkout@v4

.gitignore

@@ -17,4 +17,6 @@ github-stats-cache.json
 pip_overrides.json
 *.json
 check2.sh
-/venv/
+/venv/
+build
+*.egg-info

MANIFEST.in

@@ -0,0 +1,7 @@
+include comfyui_manager/js/*
+include comfyui_manager/*.json
+include comfyui_manager/glob/*
+include LICENSE.txt
+include README.md
+include requirements.txt
+include pyproject.toml

README.md

@@ -5,6 +5,7 @@
 ![menu](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/refs/heads/Main/ComfyUI-Manager/images/dialog.jpg)
 
 ## NOTICE
+* V4.0: Modify the structure to be installable via pip instead of using git clone.
 * V3.16: Support for `uv` has been added. Set `use_uv` in `config.ini`.
 * V3.10: `double-click feature` is removed
   * This feature has been moved to https://github.com/ltdrdata/comfyui-connection-helper
@@ -13,78 +14,26 @@
 
 ## Installation
 
-### Installation[method1] (General installation method: ComfyUI-Manager only)
+* When installing the latest ComfyUI, it will be automatically installed as a dependency, so manual installation is no longer necessary.
 
-To install ComfyUI-Manager in addition to an existing installation of ComfyUI, you can follow the following steps:
+* Manual installation of the nightly version:
+    * Clone to a temporary directory (**Note:** Do **not** clone into `ComfyUI/custom_nodes`.)
+      ```  
+      git clone https://github.com/Comfy-Org/ComfyUI-Manager  
+      ```  
+    * Install via pip
+      ```  
+      cd ComfyUI-Manager  
+      pip install .  
+      ```
 
-1. goto `ComfyUI/custom_nodes` dir in terminal(cmd)
-2. `git clone https://github.com/ltdrdata/ComfyUI-Manager comfyui-manager`
-3. Restart ComfyUI
-
-
-### Installation[method2] (Installation for portable ComfyUI version: ComfyUI-Manager only)
-1. install git 
-- https://git-scm.com/download/win
-- standalone version  
-- select option: use windows default console window
-2. Download [scripts/install-manager-for-portable-version.bat](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-manager-for-portable-version.bat) into installed `"ComfyUI_windows_portable"` directory
-- Don't click. Right click the link and use save as...
-3. double click `install-manager-for-portable-version.bat` batch file
-
-![portable-install](https://raw.githubusercontent.com/ltdrdata/ComfyUI-extension-tutorials/Main/ComfyUI-Manager/images/portable-install.jpg)
-
-
-### Installation[method3] (Installation through comfy-cli: install ComfyUI and ComfyUI-Manager at once.)  
-> RECOMMENDED: comfy-cli provides various features to manage ComfyUI from the CLI.
-
-* **prerequisite: python 3, git**
-
-Windows:
-```commandline
-python -m venv venv
-venv\Scripts\activate
-pip install comfy-cli
-comfy install
-```
-
-Linux/OSX:
-```commandline
-python -m venv venv
-. venv/bin/activate
-pip install comfy-cli
-comfy install
-```
 * See also: https://github.com/Comfy-Org/comfy-cli
 
 
-### Installation[method4] (Installation for linux+venv: ComfyUI + ComfyUI-Manager)
-
-To install ComfyUI with ComfyUI-Manager on Linux using a venv environment, you can follow these steps:
-* **prerequisite: python-is-python3, python3-venv, git**
-
-1. Download [scripts/install-comfyui-venv-linux.sh](https://github.com/ltdrdata/ComfyUI-Manager/raw/main/scripts/install-comfyui-venv-linux.sh) into empty install directory
-- Don't click. Right click the link and use save as...
-- ComfyUI will be installed in the subdirectory of the specified directory, and the directory will contain the generated executable script.
-2. `chmod +x install-comfyui-venv-linux.sh`
-3. `./install-comfyui-venv-linux.sh`
-
-### Installation Precautions
-* **DO**: `ComfyUI-Manager` files must be accurately located in the path `ComfyUI/custom_nodes/comfyui-manager`
-  * Installing in a compressed file format is not recommended.
-* **DON'T**: Decompress directly into the `ComfyUI/custom_nodes` location, resulting in the Manager contents like `__init__.py` being placed directly in that directory.
-  * You have to remove all ComfyUI-Manager files from `ComfyUI/custom_nodes`
-* **DON'T**: In a form where decompression occurs in a path such as `ComfyUI/custom_nodes/ComfyUI-Manager/ComfyUI-Manager`.
-* **DON'T**: In a form where decompression occurs in a path such as `ComfyUI/custom_nodes/ComfyUI-Manager-main`.
-  * In such cases, `ComfyUI-Manager` may operate, but it won't be recognized within `ComfyUI-Manager`, and updates cannot be performed. It also poses the risk of duplicate installations. Remove it and install properly via `git clone` method.
-
-
-You can execute ComfyUI by running either `./run_gpu.sh` or `./run_cpu.sh` depending on your system configuration.
+## Front-end
 
-## Colab Notebook
-This repository provides Colab notebooks that allow you to install and use ComfyUI, including ComfyUI-Manager. To use ComfyUI, [click on this link](https://colab.research.google.com/github/ltdrdata/ComfyUI-Manager/blob/main/notebooks/comfyui_colab_with_manager.ipynb).
-* Support for installing ComfyUI
-* Support for basic installation of ComfyUI-Manager
-* Support for automatically installing dependencies of custom nodes upon restarting Colab notebooks.
+* The built-in front-end of ComfyUI-Manager is the legacy front-end. The front-end for ComfyUI-Manager is now provided via [ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend).
+* To enable the legacy front-end, set the environment variable `ENABLE_LEGACY_COMFYUI_MANAGER_FRONT` to `true` before running.
 
 
 ## How To Use

cm-cli.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-python cm-cli.py $*
+python ./comfyui_manager/cm-cli.py $*

comfyui_manager/__init__.py

@@ -0,0 +1,24 @@
+import os
+import logging
+from comfy.cli_args import args
+
+ENABLE_LEGACY_COMFYUI_MANAGER_FRONT_DEFAULT = True # Enable legacy ComfyUI Manager frontend while new UI is in beta phase
+
+def prestartup():
+    from . import prestartup_script  # noqa: F401
+    logging.info('[PRE] ComfyUI-Manager')
+
+
+def start():
+    logging.info('[START] ComfyUI-Manager')
+    from .glob import manager_server  # noqa: F401
+    from .glob import share_3rdparty  # noqa: F401
+    from .glob import cm_global       # noqa: F401
+
+    should_show_legacy_manager_front = os.environ.get('ENABLE_LEGACY_COMFYUI_MANAGER_FRONT', 'false') == 'true' or ENABLE_LEGACY_COMFYUI_MANAGER_FRONT_DEFAULT
+    if not args.disable_manager and should_show_legacy_manager_front:
+        try:
+            import nodes
+            nodes.EXTENSION_WEB_DIRS['comfyui-manager-legacy'] = os.path.join(os.path.dirname(__file__), 'js')
+        except Exception as e:
+            print("Error enabling legacy ComfyUI Manager frontend:", e)

cm-cli.py → comfyui_manager/cm-cli.py

@@ -15,31 +15,30 @@
 import importlib
 
 
-sys.path.append(os.path.dirname(__file__))
-sys.path.append(os.path.join(os.path.dirname(__file__), "glob"))
-
 import manager_util
 
 # read env vars
 # COMFYUI_FOLDERS_BASE_PATH is not required in cm-cli.py
 # `comfy_path` should be resolved before importing manager_core
+
 comfy_path = os.environ.get('COMFYUI_PATH')
+
 if comfy_path is None:
-    try:
-        import folder_paths
-        comfy_path = os.path.join(os.path.dirname(folder_paths.__file__))
-    except:
-        print("\n[bold yellow]WARN: The `COMFYUI_PATH` environment variable is not set. Assuming `custom_nodes/ComfyUI-Manager/../../` as the ComfyUI path.[/bold yellow]", file=sys.stderr)
-        comfy_path = os.path.abspath(os.path.join(manager_util.comfyui_manager_path, '..', '..'))
+    print("[bold red]cm-cli: environment variable 'COMFYUI_PATH' is not specified.[/bold red]")
+    exit(-1)
 
-# This should be placed here
 sys.path.append(comfy_path)
 
+if not os.path.exists(os.path.join(comfy_path, 'folder_paths.py')):
+    print("[bold red]cm-cli: '{comfy_path}' is not a valid 'COMFYUI_PATH' location.[/bold red]")
+    exit(-1)
+
+
 import utils.extra_config
-import cm_global
-import manager_core as core
-from manager_core import unified_manager
-import cnr_utils
+from .glob import cm_global
+from .glob import manager_core as core
+from .glob.manager_core import unified_manager
+from .glob import cnr_utils
 
 comfyui_manager_path = os.path.abspath(os.path.dirname(__file__))
 

glob/cnr_utils.py → comfyui_manager/glob/cnr_utils.py

@@ -6,8 +6,9 @@
 from dataclasses import dataclass
 from typing import List
 
-import manager_core
-import manager_util
+from . import manager_core
+from . import manager_util
+
 import requests
 import toml
 

comfyui_manager/glob/enums.py

@@ -0,0 +1,17 @@
+import enum
+
+class NetworkMode(enum.Enum):
+    PUBLIC = "public"
+    PRIVATE = "private"
+    OFFLINE = "offline"
+
+class SecurityLevel(enum.Enum):
+    STRONG = "strong"
+    NORMAL = "normal"
+    NORMAL_MINUS = "normal-minus"
+    WEAK = "weak"
+
+class DBMode(enum.Enum):
+    LOCAL = "local"
+    CACHE = "cache"
+    REMOTE = "remote"

git_helper.py → comfyui_manager/glob/git_helper.py

@@ -15,9 +15,12 @@
 git_exe_path = os.environ.get('GIT_EXE_PATH')
 
 if comfy_path is None:
-    print("\nWARN: The `COMFYUI_PATH` environment variable is not set. Assuming `custom_nodes/ComfyUI-Manager/../../` as the ComfyUI path.", file=sys.stderr)
-    comfy_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
+    print("git_helper: environment variable 'COMFYUI_PATH' is not specified.")
+    exit(-1)
 
+if not os.path.exists(os.path.join(comfy_path, 'folder_paths.py')):
+    print("git_helper: '{comfy_path}' is not a valid 'COMFYUI_PATH' location.")
+    exit(-1)
 
 def download_url(url, dest_folder, filename=None):
     # Ensure the destination folder exists