griptape-nodes-engine 0.84.0__tar.gz

griptape_nodes_engine-0.84.0/PKG-INFO

@@ -0,0 +1,112 @@
+Metadata-Version: 2.3
+Name: griptape-nodes-engine
+Version: 0.84.0
+Summary: Add your description here
+Requires-Dist: griptape>=1.10.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,<17.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: mcp[ws]>=1.10.1
+Requires-Dist: binaryornot>=0.4.4
+Requires-Dist: pillow>=11.3.0
+Requires-Dist: static-ffmpeg>=3.0
+Requires-Dist: watchfiles>=1.1.0
+Requires-Dist: typer>=0.15.0
+Requires-Dist: huggingface-hub>=1.9.0
+Requires-Dist: rich>=14.1.0
+Requires-Dist: semver>=3.0.4
+Requires-Dist: anyio>=4.0
+Requires-Dist: ruamel-yaml>=0.18.15
+Requires-Dist: asyncio-thread-runner>=1.0
+Requires-Dist: portalocker>=2.10.0
+Requires-Dist: pygit2>=1.19.0
+Requires-Dist: send2trash>=2.1.0
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: truststore>=0.10.1
+Requires-Dist: cattrs>=26.1.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
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/img/griptape_nodes_from_foundry_white.svg">
+  <img alt="Griptape Nodes" src="docs/assets/img/griptape_nodes_from_foundry_black.svg" width="600">
+</picture>
+
+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/)
+- **📋 Migration Guide:** [MIGRATION.md](MIGRATION.md) - Guide for migrating from deprecated nodes
+
+**🧩 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
+
+### Option 1: Griptape Nodes Desktop (Recommended)
+
+Download [Griptape Nodes Desktop](https://www.griptapenodes.com/griptape-nodes-desktop) — a bundled app that includes both the engine and the editor. No additional setup required.
+
+### Option 2: Manual Engine Install
+
+For users who prefer to install the engine directly:
+
+1. **🔐 Login:** Visit [Griptape Nodes](https://app.nodes.griptape.ai/) and log in or sign up using your Griptape Cloud credentials.
+
+1. **💾 Install Engine:** Install the engine using [uv](https://docs.astral.sh/uv/):
+
+    ```bash
+    uv tool install griptape-nodes
+    ```
+
+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_engine-0.84.0/README.md

@@ -0,0 +1,72 @@
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/img/griptape_nodes_from_foundry_white.svg">
+  <img alt="Griptape Nodes" src="docs/assets/img/griptape_nodes_from_foundry_black.svg" width="600">
+</picture>
+
+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/)
+- **📋 Migration Guide:** [MIGRATION.md](MIGRATION.md) - Guide for migrating from deprecated nodes
+
+**🧩 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
+
+### Option 1: Griptape Nodes Desktop (Recommended)
+
+Download [Griptape Nodes Desktop](https://www.griptapenodes.com/griptape-nodes-desktop) — a bundled app that includes both the engine and the editor. No additional setup required.
+
+### Option 2: Manual Engine Install
+
+For users who prefer to install the engine directly:
+
+1. **🔐 Login:** Visit [Griptape Nodes](https://app.nodes.griptape.ai/) and log in or sign up using your Griptape Cloud credentials.
+
+1. **💾 Install Engine:** Install the engine using [uv](https://docs.astral.sh/uv/):
+
+    ```bash
+    uv tool install griptape-nodes
+    ```
+
+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_engine-0.84.0/pyproject.toml

@@ -0,0 +1,169 @@
+[project]
+name = "griptape-nodes-engine"
+version = "0.84.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12.0, <3.13"
+dependencies = [
+  "griptape>=1.10.0",
+  "pydantic>=2.10.6",
+  "python-dotenv>=1.0.1",
+  "xdg-base-dirs>=6.0.2",
+  "httpx>=0.28.0,<1.0.0",
+  "websockets>=15.0.1,<17.0.0",
+  "tomlkit>=0.13.2",
+  # TODO: https://github.com/griptape-ai/griptape-nodes/issues/833
+  "uv>=0.6.16",
+  "fastapi>=0.115.12",
+  "uvicorn>=0.34.2",
+  "packaging>=25.0",
+  "python-multipart>=0.0.20",
+  "json-repair>=0.46.1",
+  "mcp[ws]>=1.10.1",
+  "binaryornot>=0.4.4",
+  "pillow>=11.3.0",
+  "static-ffmpeg>=3.0",
+  "watchfiles>=1.1.0",
+  "typer>=0.15.0",
+  "huggingface-hub>=1.9.0",
+  "rich>=14.1.0",
+  "semver>=3.0.4",
+  "anyio>=4.0",
+  "ruamel.yaml>=0.18.15",
+  "asyncio-thread-runner>=1.0",
+  "portalocker>=2.10.0",
+  "pygit2>=1.19.0",
+  "send2trash>=2.1.0",
+  "tenacity>=9.0.0",
+  "truststore>=0.10.1",
+  "cattrs>=26.1.0",
+]
+
+[project.optional-dependencies]
+profiling = ["austin-dist>=3.7.0"]
+
+[dependency-groups]
+dev = [
+  "griptape-cloud-client",
+  "mdformat>=0.7.22",
+  "mdformat-gfm>=0.4.1",
+  "mdformat-frontmatter>=2.0.8",
+  "mdformat-footnote>=0.1.1",
+  "mdformat-mkdocs>=4.1.2",
+  "pyright>=1.1.396",
+  "ruff>=0.11.0",
+  "typos>=1.30.2",
+]
+docs = [
+  "mkdocs-material>=9.6.9",
+  "mkdocs>=1.5.2",
+  "mkdocstrings[python]>=0.29.1",
+  "mkdocs-mermaid2-plugin>=1.2.2",
+  "pymdown-extensions>=10.17",
+]
+test = [
+  "pytest>=8.3.5",
+  "pytest-asyncio>=1.1.0",
+  "pytest-mock>=3.14.0",
+  "pytest-xdist>=3.6.1",
+  "pytest-cov>=6.0.0",
+  "coverage>=7.0.0",
+]
+
+[project.scripts]
+# TODO: remove these entries when the CLI moves to the griptape-nodes-app repo. https://github.com/griptape-ai/griptape-nodes-app/issues/7
+griptape-nodes = "griptape_nodes:main"
+gtn = "griptape_nodes:main"
+
+[build-system]
+requires = ["uv_build>=0.7.2,<0.12"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "griptape_nodes"
+
+[tool.uv.sources]
+griptape-cloud-client = { git = "https://github.com/griptape-ai/griptape-cloud-python-client", rev = "main" }
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"
+pythonpath = ["libraries/griptape_nodes_library"]
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["libraries/**/templates/*.py"]
+
+
+[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
+  "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]
+"nodes.griptape_nodes_library".msg = "Import from griptape_nodes_library instead of nodes.griptape_nodes_library"
+"libraries.griptape_nodes_library".msg = "Import from griptape_nodes_library instead of libraries.griptape_nodes_library"
+"libraries.griptape_nodes_advanced_media_library".msg = "Import from griptape_nodes_advanced_media_library instead of libraries.griptape_nodes_advanced_media_library"
+"libraries.griptape_cloud".msg = "Import from griptape_cloud instead of libraries.griptape_cloud"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "D104"]
+"libraries/**/tests/**" = ["S101", "D104", "INP001"]
+"src/griptape_nodes/retained_mode/events/*" = ["TC001"]
+
+[tool.ruff.lint.flake8-type-checking]
+runtime-evaluated-base-classes = ["pydantic.BaseModel"]
+
+[tool.ruff.lint.flake8-annotations]
+mypy-init-return = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.typos]
+files.extend-exclude = ["libraries/**/templates/*"]
+default.extend-ignore-re = [
+  # Ignore any line that ends with this comment:
+  "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+  # Or: ignore the *next* line after this comment:
+  "(?m)(#|//)\\s*spellchecker:ignore-next-line\\n.*",
+]
+
+[tool.typos.default.extend-words]
+# HALD CLUT is a Color Lookup Table technique named after its inventor
+HALD = "HALD"
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+include = ["."]
+exclude = [
+  "libraries/**/templates/*",
+  ".venv",
+  "GriptapeNodes",
+  "**/node_modules",
+  "**/__pycache__",
+  "**/.*",
+]
+pythonVersion = "3.12"
+reportIncompatibleMethodOverride = false

griptape_nodes_engine-0.84.0/src/griptape_nodes/__init__.py

@@ -0,0 +1,24 @@
+"""Griptape Nodes package."""
+
+import sys
+from pathlib import Path
+
+from rich.console import Console
+
+
+def main() -> None:
+    """Main entry point for the Griptape Nodes CLI."""
+    # Hack to make paths "just work". # noqa: FIX004
+    # Without this, packages like `nodes` don't properly import.
+    # Long term solution could be to make `nodes` a proper src-layout package
+    # but current engine relies on importing files rather than packages.
+    sys.path.append(str(Path.cwd()))
+
+    console = Console()
+    with console.status("[bold green]Loading Griptape Nodes...", spinner="dots"):
+        from griptape_nodes.cli.main import app
+
+    app()
+
+
+__all__ = ["main"]

griptape_nodes_engine-0.84.0/src/griptape_nodes/__main__.py

@@ -0,0 +1,6 @@
+"""Main entry point for the Griptape Nodes CLI when run as a module."""
+
+from griptape_nodes import main
+
+if __name__ == "__main__":
+    main()

griptape_nodes_engine-0.84.0/src/griptape_nodes/api_client/__init__.py

@@ -0,0 +1,9 @@
+"""API client for Nodes API communication."""
+
+from griptape_nodes.api_client.client import Client
+from griptape_nodes.api_client.request_client import RequestClient
+
+__all__ = [
+    "Client",
+    "RequestClient",
+]