Comfy-Org · christian-byrne · May 20, 2025 · May 20, 2025 · May 20, 2025 · May 20, 2025
diff --git a/.env.example b/.env.example
@@ -0,0 +1 @@
+PYPI_TOKEN=your-pypi-token
diff --git a/.github/workflows/publish-to-pypi.yml b/.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 
diff --git a/.github/workflows/publish.yml b/.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

diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,7 @@ github-stats-cache.json
 pip_overrides.json
 *.json
 check2.sh
-/venv/
+/venv/
+build
+*.egg-info
+.env
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+## Testing Changes
+
+1. Activate the ComfyUI environment.
+
+2. Build package locally after making changes.
+
+```bash
+# from inside the ComfyUI-Manager directory, with the ComfyUI environment activated
+python -m build
+```
+
+3. Install the package locally in the ComfyUI environment.
+
+```bash
+# Uninstall existing package
+pip uninstall comfyui-manager
+
+# Install the locale package
+pip install dist/comfyui-manager-*.whl
+```
+
+4. Start ComfyUI.
+
+```bash
+# after navigating to the ComfyUI directory
+python main.py
+```
+
+## Manually Publish Test Version to PyPi
+
+1. Set the `PYPI_TOKEN` environment variable in env file.
+
+2. If manually publishing, you likely want to use a release candidate version, so set the version in [pyproject.toml](pyproject.toml) to something like `0.0.1rc1`.
+
+3. Build the package.
+
+```bash
+python -m build
+```
+
+4. Upload the package to PyPi.
+
+```bash
+python -m twine upload dist/* --username __token__ --password $PYPI_TOKEN
+```
+
+5. View at https://pypi.org/project/comfyui-manager/
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,14 @@
+include comfyui_manager/js/*
+include comfyui_manager/*.json
+include comfyui_manager/glob/*
+include LICENSE.txt
+include README.md
+include requirements.txt
+include pyproject.toml
+include custom-node-list.json
+include extension-node-list.json
+include extras.json
+include github-stats.json
+include model-list.json
+include alter-list.json
+include comfyui_manager/channels.list.template
diff --git a/README.md b/README.md
@@ -5,86 +5,35 @@
 ![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
-* V3.3.2: Overhauled. Officially supports [https://comfyregistry.org/](https://comfyregistry.org/).
+* V3.3.2: Overhauled. Officially supports [https://registry.comfy.org/](https://registry.comfy.org/).
 * You can see whole nodes info on [ComfyUI Nodes Info](https://ltdrdata.github.io/) page.
 
 ## 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

diff --git a/__init__.py b/__init__.py
diff --git a/channels.list.template b/channels.list.template
diff --git a/cm-cli.sh b/cm-cli.sh
diff --git a/comfyui_manager/__init__.py b/comfyui_manager/__init__.py
@@ -0,0 +1,45 @@
+import os
+import logging
+
+def prestartup():
+    from . import prestartup_script  # noqa: F401
+    logging.info('[PRE] ComfyUI-Manager')
+
+
+def start():
+    from comfy.cli_args import args
+
+    logging.info('[START] ComfyUI-Manager')
+    from .common import cm_global     # noqa: F401
+
+    if not args.disable_manager:
+        if args.enable_manager_legacy_ui:
+            try:
+                from .legacy import manager_server  # noqa: F401
+                from .legacy import share_3rdparty  # noqa: F401
+                import nodes
+
+                logging.info("[ComfyUI-Manager] Legacy UI is enabled.")
+                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)
+        else:
+            from .glob import manager_server  # noqa: F401
+            from .glob import share_3rdparty  # noqa: F401
+
+
+def should_be_disabled(fullpath:str) -> bool:
+    """
+    1. Disables the legacy ComfyUI-Manager.
+    2. The blocklist can be expanded later based on policies.
+    """
+    from comfy.cli_args import args
+
+    if not args.disable_manager:
+        # In cases where installation is done via a zip archive, the directory name may not be comfyui-manager, and it may not contain a git repository.
+        # It is assumed that any installed legacy ComfyUI-Manager will have at least 'comfyui-manager' in its directory name.
+        dir_name = os.path.basename(fullpath).lower()
+        if 'comfyui-manager' in dir_name:
+            return True
+
+    return False
diff --git a/comfyui_manager/channels.list.template b/comfyui_manager/channels.list.template
@@ -0,0 +1,6 @@
+default::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main
+recent::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main/node_db/new
+legacy::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main/node_db/legacy
+forked::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main/node_db/forked
+dev::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main/node_db/dev
+tutorial::https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main/node_db/tutorial
diff --git a/...shots/the_snapshot_files_are_located_here → comfyui_manager/cm_cli/__init__.py b/...shots/the_snapshot_files_are_located_here → comfyui_manager/cm_cli/__init__.py