Scaffold

Author: benceruleanlu

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+    paths:
+      - "pyproject.toml"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main') ||
+      (github.event_name == 'push' && github.ref == 'refs/heads/main')
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install build
+
+      - name: Setup package
+        run: |
+          mkdir -p comfyui_embedded_docs/docs/
+          cp -r docs/* comfyui_embedded_docs/docs/
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+.venv
+dist
+*.egg-info

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE
+include README.md
+recursive-include comfyui_embedded_docs/docs *.md *.jpg *.png *.gif *.webp

README.md

@@ -0,0 +1,21 @@
+# comfyui_embedded_docs
+
+## Updating Documentation
+
+Documentation files are stored in the `docs/` directory. Each node has its own subdirectory containing:
+- `en.md` - English documentation
+- `assets/` - Images and other assets used in the documentation
+
+To update documentation, simply add or edit the relevant markdown files in the `docs/` directory.
+
+## Publishing
+
+The package is automatically published to PyPI when:
+1. You manually trigger the workflow (Actions → Publish to PyPI → Run workflow)
+2. You push changes to `pyproject.toml` on the main branch
+3. A pull request that modifies `pyproject.toml` is merged to main
+
+The publishing workflow:
+1. Copies documentation from `docs/` to `comfyui_embedded_docs/docs/`
+2. Builds the package using `python -m build`
+3. Publishes to PyPI using the configured PYPI_TOKEN secret

comfyui_embedded_docs/__init__.py

@@ -0,0 +1 @@
+# comfyui_embedded_docs package

docs/FluxProUltraImageNode/assets/flux-1-1-pro-ultra-image.jpg

@@ -0,0 +1,40 @@
+![ComfyUI Native Flux 1.1 [pro] Ultra Image node](assets/flux-1-1-pro-ultra-image.jpg)
+
+The Flux 1.1 [pro] Ultra Image node allows you to generate ultra-high-resolution images through text prompts, directly connecting to Black Forest Labs' latest image generation API.
+
+This node supports two main usage modes:
+1. **Text-to-Image**: Generate high-quality images from text prompts (when no image input is used)
+2. **Image-to-Image**: Combine existing images with prompts to create new images that blend features from both (Remix mode)
+
+This node supports Ultra mode through API calls, capable of generating images at 4 times the resolution of standard Flux 1.1 [pro] (up to 4MP), without sacrificing prompt adherence, and maintaining super-fast generation times of just 10 seconds. Compared to other high-resolution models, it's more than 2.5 times faster.
+
+## Parameter Description
+
+### Basic Parameters
+
+| Parameter         | Type    | Default | Description                                                                                                                                                                                                                      |
+| ----------------- | ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| prompt            | String  | ""      | Text description for generating the image                                                                                                                                                                                        |
+| prompt_upsampling | Boolean | False   | Whether to use prompt upsampling technique to enhance details. When enabled, automatically modifies prompts for more creative generation, but results become non-deterministic (same seed won't produce exactly the same result) |
+| seed              | Integer | 0       | Random seed value, controls generation randomness                                                                                                                                                                                |
+| aspect_ratio      | String  | "16:9"  | Width-to-height ratio of the image, must be between 1:4 and 4:1                                                                                                                                                                  |
+| raw               | Boolean | False   | When set to True, generates less processed, more natural-looking images                                                                                                                                                          |
+
+### Optional Parameters
+
+| Parameter             | Type  | Default | Description                                                                                                                                               |
+| --------------------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| image_prompt          | Image | None    | Optional input, used for Image-to-Image (Remix) mode                                                                                                      |
+| image_prompt_strength | Float | 0.1     | Active when `image_prompt` is input, adjusts the blend between prompt and image prompt. Higher values make output closer to input image, range is 0.0-1.0 |
+
+### Output
+
+| Output | Type  | Description                            |
+| ------ | ----- | -------------------------------------- |
+| IMAGE  | Image | Generated high-resolution image result |
+
+## How It Works
+
+Flux 1.1 [pro] Ultra mode uses optimized deep learning architecture and efficient GPU acceleration technology to achieve high-resolution image generation without sacrificing speed. When a request is sent to the API, the system parses the prompt, applies appropriate parameters, then computes the image in parallel, finally generating and returning the high-resolution result.
+
+Compared to regular models, Ultra mode particularly focuses on detail preservation and consistency at large scales, ensuring impressive quality even at 4MP high resolution.

docs/FluxProUltraImageNode/en.md

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "comfyui-embedded-docs"
+version = "0.1.0"
+description = "Embedded documentation for ComfyUI nodes"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "GPL-3.0"
+authors = [
+    {name = "Comfy-Org"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+repository = "https://github.com/Comfy-Org/comfyui-embedded-docs"
+
+[tool.setuptools.package-data]
+comfyui_embedded_docs = ["docs/**/*.md", "docs/**/*.jpg", "docs/**/*.png", "docs/**/*.gif", "docs/**/*.webp"]