griptape-nodes 0.42.0__tar.gz → 0.43.1__tar.gz

griptape_nodes-0.43.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.3
+Name: griptape-nodes
+Version: 0.43.1
+Summary: Add your description here
+Requires-Dist: griptape>=1.8.0
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: xdg-base-dirs>=6.0.2
+Requires-Dist: httpx>=0.28.0,<1.0.0
+Requires-Dist: websockets>=15.0.1,<16.0.0
+Requires-Dist: tomlkit>=0.13.2
+Requires-Dist: uv>=0.6.16
+Requires-Dist: fastapi>=0.115.12
+Requires-Dist: uvicorn>=0.34.2
+Requires-Dist: packaging>=25.0
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: json-repair>=0.46.1
+Requires-Dist: imageio-ffmpeg>=0.6.0
+Requires-Dist: mcp[ws]>=1.10.1
+Requires-Dist: binaryornot>=0.4.4
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: austin-dist>=3.7.0 ; extra == 'profiling'
+Requires-Python: >=3.12.0, <3.13
+Provides-Extra: profiling
+Description-Content-Type: text/markdown
+
+# 🎨 Griptape Nodes
+
+Griptape Nodes is a powerful, visual, node-based workflow builder designed for professional artists and creators. Build and execute complex AI workflows through the cloud-based [Griptape Nodes IDE](https://app.nodes.griptape.ai/) - an intuitive drag-and-drop interface.
+
+This repository contains the Griptape Nodes Engine - the local component that runs securely on your machine, providing a performant foundation for workflow execution.
+
+[![Griptape Nodes Trailer Preview](docs/assets/img/video-thumbnail.jpg)](https://vimeo.com/1064451891)
+*(Clicking the image opens the video on Vimeo)*
+
+**✨ Key Features:**
+
+- **🎯 Visual Workflow Editor:** Design and connect nodes representing different AI tasks, tools, and logic through the cloud-based IDE
+- **🏠 Local Engine:** Run workflows securely on your own machine or infrastructure
+- **🐍 Portable Python Workflows:** Workflows are saved as self-executable Python files for portability, debugability, and learning
+- **🌐 Multi-Device Access:** Client/server architecture lets you access your workflows from any device
+- **🧩 Extensible:** Build your own custom nodes and libraries to extend functionality
+- **⚡ Scriptable Interface:** Interact with and control flows programmatically
+
+**🔗 Learn More:**
+
+- **📚 Full Documentation:** [docs.griptapenodes.com](https://docs.griptapenodes.com)
+- **⚙️ Installation:** [docs.griptapenodes.com/en/stable/installation/](https://docs.griptapenodes.com/en/latest/installation/)
+- **🔧 Engine Configuration:** [docs.griptapenodes.com/en/stable/configuration/](https://docs.griptapenodes.com/en/latest/configuration/)
+
+**🧩 Extending Griptape Nodes:**
+
+Want to create custom nodes for your specific workflow needs? Griptape Nodes is designed to be extensible through custom libraries:
+
+- **📦 Custom Library Template:** Get started with the [Griptape Nodes Library Template](https://github.com/griptape-ai/griptape-nodes-library-template)
+- **🛠️ Build Custom Nodes:** Create specialized nodes tailored to your artistic and creative workflows
+
+______________________________________________________________________
+
+## 🚀 Quick Installation
+
+Follow these steps to get the Griptape Nodes engine running on your system:
+
+1. **🔐 Login:** Visit [Griptape Nodes](https://app.nodes.griptape.ai/) and log in or sign up using your Griptape Cloud credentials.
+
+1. **💾 Install Command:** Once logged in, you'll find a setup screen. Copy the installation command provided in the "New Installation" section. It will look similar to this (use the **exact** command provided on the website):
+
+    ```bash
+    curl -LsSf https://raw.githubusercontent.com/griptape-ai/griptape-nodes/main/install.sh | bash
+    ```
+
+1. **⚡ Run Installer:** Open a terminal on your machine (local or cloud environment) and paste/run the command. The installer uses `uv` for fast installation; if `uv` isn't present, the script will typically handle installing it.
+
+1. **⚙️ Initial Configuration (Automatic on First Run):**
+
+    - The first time you run the engine command (`griptape-nodes` or `gtn`), it will guide you through the initial setup:
+    - **📁 Workspace Directory:** You'll be prompted to choose a directory where Griptape Nodes will store configurations, project files, secrets (`.env`), and generated assets. You can accept the default (`<current_directory>/GriptapeNodes`) or specify a custom path.
+    - **🔑 Griptape Cloud API Key:** Return to the [Griptape Nodes setup page](https://app.nodes.griptape.ai/) in your browser, click "Generate API Key", copy the key, and paste it when prompted in the terminal.
+
+1. **🚀 Start the Engine:** After configuration, start the engine by running:
+
+    ```bash
+    griptape-nodes
+    ```
+
+    *(or the shorter alias `gtn`)*
+
+1. **🔗 Connect Workflow Editor:** Refresh the Griptape Nodes Workflow Editor page in your browser. It should now connect to your running engine.
+
+You're now ready to start building flows! 🎉 For more detailed setup options and troubleshooting, see the full [Documentation](https://docs.griptapenodes.com/).

griptape_nodes-0.43.1/README.md

@@ -0,0 +1,64 @@
+# 🎨 Griptape Nodes
+
+Griptape Nodes is a powerful, visual, node-based workflow builder designed for professional artists and creators. Build and execute complex AI workflows through the cloud-based [Griptape Nodes IDE](https://app.nodes.griptape.ai/) - an intuitive drag-and-drop interface.
+
+This repository contains the Griptape Nodes Engine - the local component that runs securely on your machine, providing a performant foundation for workflow execution.
+
+[![Griptape Nodes Trailer Preview](docs/assets/img/video-thumbnail.jpg)](https://vimeo.com/1064451891)
+*(Clicking the image opens the video on Vimeo)*
+
+**✨ Key Features:**
+
+- **🎯 Visual Workflow Editor:** Design and connect nodes representing different AI tasks, tools, and logic through the cloud-based IDE
+- **🏠 Local Engine:** Run workflows securely on your own machine or infrastructure
+- **🐍 Portable Python Workflows:** Workflows are saved as self-executable Python files for portability, debugability, and learning
+- **🌐 Multi-Device Access:** Client/server architecture lets you access your workflows from any device
+- **🧩 Extensible:** Build your own custom nodes and libraries to extend functionality
+- **⚡ Scriptable Interface:** Interact with and control flows programmatically
+
+**🔗 Learn More:**
+
+- **📚 Full Documentation:** [docs.griptapenodes.com](https://docs.griptapenodes.com)
+- **⚙️ Installation:** [docs.griptapenodes.com/en/stable/installation/](https://docs.griptapenodes.com/en/latest/installation/)
+- **🔧 Engine Configuration:** [docs.griptapenodes.com/en/stable/configuration/](https://docs.griptapenodes.com/en/latest/configuration/)
+
+**🧩 Extending Griptape Nodes:**
+
+Want to create custom nodes for your specific workflow needs? Griptape Nodes is designed to be extensible through custom libraries:
+
+- **📦 Custom Library Template:** Get started with the [Griptape Nodes Library Template](https://github.com/griptape-ai/griptape-nodes-library-template)
+- **🛠️ Build Custom Nodes:** Create specialized nodes tailored to your artistic and creative workflows
+
+______________________________________________________________________
+
+## 🚀 Quick Installation
+
+Follow these steps to get the Griptape Nodes engine running on your system:
+
+1. **🔐 Login:** Visit [Griptape Nodes](https://app.nodes.griptape.ai/) and log in or sign up using your Griptape Cloud credentials.
+
+1. **💾 Install Command:** Once logged in, you'll find a setup screen. Copy the installation command provided in the "New Installation" section. It will look similar to this (use the **exact** command provided on the website):
+
+    ```bash
+    curl -LsSf https://raw.githubusercontent.com/griptape-ai/griptape-nodes/main/install.sh | bash
+    ```
+
+1. **⚡ Run Installer:** Open a terminal on your machine (local or cloud environment) and paste/run the command. The installer uses `uv` for fast installation; if `uv` isn't present, the script will typically handle installing it.
+
+1. **⚙️ Initial Configuration (Automatic on First Run):**
+
+    - The first time you run the engine command (`griptape-nodes` or `gtn`), it will guide you through the initial setup:
+    - **📁 Workspace Directory:** You'll be prompted to choose a directory where Griptape Nodes will store configurations, project files, secrets (`.env`), and generated assets. You can accept the default (`<current_directory>/GriptapeNodes`) or specify a custom path.
+    - **🔑 Griptape Cloud API Key:** Return to the [Griptape Nodes setup page](https://app.nodes.griptape.ai/) in your browser, click "Generate API Key", copy the key, and paste it when prompted in the terminal.
+
+1. **🚀 Start the Engine:** After configuration, start the engine by running:
+
+    ```bash
+    griptape-nodes
+    ```
+
+    *(or the shorter alias `gtn`)*
+
+1. **🔗 Connect Workflow Editor:** Refresh the Griptape Nodes Workflow Editor page in your browser. It should now connect to your running engine.
+
+You're now ready to start building flows! 🎉 For more detailed setup options and troubleshooting, see the full [Documentation](https://docs.griptapenodes.com/).

{griptape_nodes-0.42.0 → griptape_nodes-0.43.1}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "griptape-nodes"
-version = "0.42.0"
+version = "0.43.1"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.12.0, <3.13"
 dependencies = [
-  "griptape[drivers-prompt-amazon-bedrock,drivers-prompt-anthropic,drivers-prompt-cohere,drivers-prompt-ollama,drivers-web-scraper-trafilatura,drivers-web-search-duckduckgo,drivers-web-search-exa,loaders-image]>=1.7.1",
+  "griptape>=1.8.0",
   "pydantic>=2.10.6",
   "python-dotenv>=1.0.1",
   "xdg-base-dirs>=6.0.2",
@@ -20,6 +20,9 @@ dependencies = [
   "python-multipart>=0.0.20",
   "json-repair>=0.46.1",
   "imageio-ffmpeg>=0.6.0",
+  "mcp[ws]>=1.10.1",
+  "binaryornot>=0.4.4",
+  "pillow>=11.3.0",
 ]
 
 [project.optional-dependencies]
@@ -49,8 +52,8 @@ griptape-nodes = "griptape_nodes:main"
 gtn = "griptape_nodes:main"
 
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["uv_build"]
+build-backend = "uv_build"
 
 [tool.ruff]
 line-length = 120
@@ -61,27 +64,28 @@ exclude = [".venv"]
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-  "TD002",  # Intentional
-  "FIX002", # Intentional
-  "D101",   # Intentional
-  "D102",   # Intentional
-  "D107",   # Intentional
-  "ANN002", # Intentional
-  "ANN003", # Intentional
-  "ANN401", # Intentional
-  "COM812", # Intentional
-  "E501",   # TODO: https://github.com/griptape-ai/griptape-nodes/issues/834 
-  "D100",   # TODO: https://github.com/griptape-ai/griptape-nodes/issues/835 
-  "BLE001", # TODO: https://github.com/griptape-ai/griptape-nodes/issues/839
-  "B026",   # TODO: https://github.com/griptape-ai/griptape-nodes/issues/836 
-  "SLF001", # TODO :https://github.com/griptape-ai/griptape-nodes/issues/838 
-  "SIM108", # Intentional
-  "SIM110", # Intentional
-  "D105",   # Intentional
-  "N802",   # TODO: https://github.com/griptape-ai/griptape-nodes/issues/840
-  "TRY400", # Intentional
-  "FBT003", # Intentional
-  "RET504", # Intentional
+  "TD002",   # Intentional
+  "FIX002",  # Intentional
+  "D101",    # Intentional
+  "D102",    # Intentional
+  "D107",    # Intentional
+  "ANN002",  # Intentional
+  "ANN003",  # Intentional
+  "ANN401",  # Intentional
+  "COM812",  # Intentional
+  "E501",    # TODO: https://github.com/griptape-ai/griptape-nodes/issues/834 
+  "D100",    # TODO: https://github.com/griptape-ai/griptape-nodes/issues/835 
+  "BLE001",  # TODO: https://github.com/griptape-ai/griptape-nodes/issues/839
+  "B026",    # TODO: https://github.com/griptape-ai/griptape-nodes/issues/836 
+  "SLF001",  # TODO :https://github.com/griptape-ai/griptape-nodes/issues/838 
+  "SIM108",  # Intentional
+  "SIM110",  # Intentional
+  "D105",    # Intentional
+  "N802",    # TODO: https://github.com/griptape-ai/griptape-nodes/issues/840
+  "TRY400",  # Intentional
+  "FBT003",  # Intentional
+  "RET504",  # Intentional
+  "PLC0415", # Intentional
 ]
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]

griptape_nodes-0.43.1/src/griptape_nodes/app/__init__.py

@@ -0,0 +1,5 @@
+"""App package."""
+
+from griptape_nodes.app.app import start_app
+
+__all__ = ["start_app"]

griptape_nodes-0.43.1/src/griptape_nodes/app/api.py

@@ -0,0 +1,199 @@
+from __future__ import annotations
+
+import binascii
+import logging
+import os
+from pathlib import Path
+from typing import TYPE_CHECKING, Annotated
+from urllib.parse import urljoin
+
+import uvicorn
+from fastapi import Depends, FastAPI, HTTPException, Request
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.staticfiles import StaticFiles
+from rich.logging import RichHandler
+
+from griptape_nodes.retained_mode.events.base_events import EventRequest, deserialize_event
+
+if TYPE_CHECKING:
+    from queue import Queue
+
+# Whether to enable the static server
+STATIC_SERVER_ENABLED = os.getenv("STATIC_SERVER_ENABLED", "true").lower() == "true"
+# Host of the static server
+STATIC_SERVER_HOST = os.getenv("STATIC_SERVER_HOST", "localhost")
+# Port of the static server
+STATIC_SERVER_PORT = int(os.getenv("STATIC_SERVER_PORT", "8124"))
+# URL path for the static server
+STATIC_SERVER_URL = os.getenv("STATIC_SERVER_URL", "/static")
+# Log level for the static server
+STATIC_SERVER_LOG_LEVEL = os.getenv("STATIC_SERVER_LOG_LEVEL", "info").lower()
+
+logger = logging.getLogger("griptape_nodes_api")
+
+# Global event queue - initialized as None and set when starting the API
+event_queue: Queue | None = None
+
+# Global static directory - initialized as None and set when starting the API
+static_dir: Path | None = None
+
+
+def get_event_queue() -> Queue:
+    """FastAPI dependency to get the event queue."""
+    if event_queue is None:
+        msg = "Event queue is not initialized"
+        raise HTTPException(status_code=500, detail=msg)
+    return event_queue
+
+
+def get_static_dir() -> Path:
+    """FastAPI dependency to get the static directory."""
+    if static_dir is None:
+        msg = "Static directory is not initialized"
+        raise HTTPException(status_code=500, detail=msg)
+    return static_dir
+
+
+"""Create and configure the FastAPI application."""
+app = FastAPI()
+
+
+@app.post("/static-upload-urls")
+async def _create_static_file_upload_url(request: Request) -> dict:
+    """Create a URL for uploading a static file.
+
+    Similar to a presigned URL, but for uploading files to the static server.
+    """
+    base_url = request.base_url
+    body = await request.json()
+    file_name = body["file_name"]
+    url = urljoin(str(base_url), f"/static-uploads/{file_name}")
+
+    return {"url": url}
+
+
+@app.put("/static-uploads/{file_path:path}")
+async def _create_static_file(
+    request: Request, file_path: str, static_directory: Annotated[Path, Depends(get_static_dir)]
+) -> dict:
+    """Upload a static file to the static server."""
+    if not STATIC_SERVER_ENABLED:
+        msg = "Static server is not enabled. Please set STATIC_SERVER_ENABLED to True."
+        raise ValueError(msg)
+
+    file_full_path = Path(static_directory / file_path)
+
+    # Create parent directories if they don't exist
+    file_full_path.parent.mkdir(parents=True, exist_ok=True)
+
+    data = await request.body()
+    try:
+        file_full_path.write_bytes(data)
+    except binascii.Error as e:
+        msg = f"Invalid base64 encoding for file {file_path}."
+        logger.error(msg)
+        raise HTTPException(status_code=400, detail=msg) from e
+    except (OSError, PermissionError) as e:
+        msg = f"Failed to write file {file_path} to {static_dir}: {e}"
+        logger.error(msg)
+        raise HTTPException(status_code=500, detail=msg) from e
+
+    static_url = f"http://{STATIC_SERVER_HOST}:{STATIC_SERVER_PORT}{STATIC_SERVER_URL}/{file_path}"
+    return {"url": static_url}
+
+
+@app.get("/static-uploads/")
+async def _list_static_files(static_directory: Annotated[Path, Depends(get_static_dir)]) -> dict:
+    """List all static files in the static server."""
+    if not STATIC_SERVER_ENABLED:
+        msg = "Static server is not enabled. Please set STATIC_SERVER_ENABLED to True."
+        raise HTTPException(status_code=500, detail=msg)
+
+    try:
+        file_names = []
+        if static_directory.exists():
+            for file_path in static_directory.rglob("*"):
+                if file_path.is_file():
+                    relative_path = file_path.relative_to(static_directory)
+                    file_names.append(str(relative_path))
+    except (OSError, PermissionError) as e:
+        msg = f"Failed to list files in static directory: {e}"
+        logger.error(msg)
+        raise HTTPException(status_code=500, detail=msg) from e
+    else:
+        return {"files": file_names}
+
+
+@app.post("/engines/request")
+async def _create_event(request: Request, queue: Annotated[Queue, Depends(get_event_queue)]) -> None:
+    body = await request.json()
+    _process_api_event(body, queue)
+
+
+def start_api(static_directory: Path, queue: Queue) -> None:
+    """Run FastAPI with Uvicorn in order to serve static files produced by nodes."""
+    global event_queue, static_dir  # noqa: PLW0603
+    event_queue = queue
+    static_dir = static_directory
+
+    logging.getLogger("uvicorn").addHandler(
+        RichHandler(show_time=True, show_path=False, markup=True, rich_tracebacks=True)
+    )
+
+    if not static_dir.exists():
+        static_dir.mkdir(parents=True, exist_ok=True)
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=[
+            os.getenv("GRIPTAPE_NODES_UI_BASE_URL", "https://app.nodes.griptape.ai"),
+            "https://app.nodes-staging.griptape.ai",
+            "http://localhost:5173",
+        ],
+        allow_credentials=True,
+        allow_methods=["OPTIONS", "GET", "POST", "PUT"],
+        allow_headers=["*"],
+    )
+
+    app.mount(
+        STATIC_SERVER_URL,
+        StaticFiles(directory=static_directory),
+        name="static",
+    )
+
+    uvicorn.run(
+        app, host=STATIC_SERVER_HOST, port=STATIC_SERVER_PORT, log_level=STATIC_SERVER_LOG_LEVEL, log_config=None
+    )
+
+
+def _process_api_event(event: dict, event_queue: Queue) -> None:
+    """Process API events and send them to the event queue."""
+    payload = event.get("payload", {})
+
+    try:
+        payload["request"]
+    except KeyError:
+        msg = "Error: 'request' was expected but not found."
+        raise RuntimeError(msg) from None
+
+    try:
+        event_type = payload["event_type"]
+        if event_type != "EventRequest":
+            msg = "Error: 'event_type' was found on request, but did not match 'EventRequest' as expected."
+            raise RuntimeError(msg) from None
+    except KeyError:
+        msg = "Error: 'event_type' not found in request."
+        raise RuntimeError(msg) from None
+
+    # Now attempt to convert it into an EventRequest.
+    try:
+        request_event = deserialize_event(json_data=payload)
+        if not isinstance(request_event, EventRequest):
+            msg = f"Deserialized event is not an EventRequest: {type(request_event)}"
+            raise TypeError(msg)  # noqa: TRY301
+    except Exception as e:
+        msg = f"Unable to convert request JSON into a valid EventRequest object. Error Message: '{e}'"
+        raise RuntimeError(msg) from None
+
+    # Add the event to the queue
+    event_queue.put(request_event)