diff --git a/README_CN.md b/README_CN.md index c9839871..04e1b83d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -46,8 +46,6 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # ⚡ 快速开始 -## 选项 A：使用 `pyspur` Python 包 - 这是入门的最快方式。需要 Python 3.11 或更高版本。 1. **安装 PySpur:** @@ -69,59 +67,18 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe 默认情况下，这将使用 SQLite 数据库在 `http://localhost:6080` 启动 PySpur 应用。 我们建议你在 `.env` 文件中配置 Postgres 实例的 URL，以获得更稳定的体验。 -4. **[可选] 自定义部署:** - 你可以通过两种方式自定义你的 PySpur 部署： - - a. **通过应用**（推荐）： - - 在应用中导航至 API 密钥标签页 - - 添加各供应商的 API 密钥（例如 OpenAI、Anthropic 等） - - 更改会立即生效 - - b. **手动配置**： - - 编辑项目目录中的 `.env` 文件 - - 建议在 .env 中配置 Postgres 数据库以获得更高的可靠性 - - 使用 `pyspur serve` 重启应用；如果不使用 Postgres，请添加 `--sqlite` - -## 选项 B：使用 Docker（推荐用于可扩展的生产系统） +4. **[可选] 配置环境和添加 API 密钥:** + - **应用界面**: 导航至 API 密钥标签页添加供应商密钥（OpenAI、Anthropic 等） + - **手动配置**: 编辑 `.env` 文件（推荐：配置 postgres）并使用 `pyspur serve` 重启 -这是生产部署的推荐方式： - -1. **安装 Docker:** - 首先，根据你的操作系统，按照官方安装指南安装 Docker： - - [Linux 上的 Docker](https://docs.docker.com/engine/install/) - - [Mac 上的 Docker Desktop](https://docs.docker.com/desktop/install/mac-install/) - -2. **创建 PySpur 项目:** - 安装 Docker 后，使用以下命令创建一个新的 PySpur 项目： - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - 这将： - - 在名为 `pyspur-project` 的新目录中启动一个新的 PySpur 项目 - - 设置所需的配置文件 - - 自动启动由本地 Postgres Docker 实例支持的 PySpur 应用 - -3. **访问 PySpur:** - 在浏览器中访问 `http://localhost:6080`。 - -4. **[可选] 自定义部署:** - 你可以通过两种方式自定义你的 PySpur 部署： - - a. **通过应用**（推荐）： - - 在应用中导航至 API 密钥标签页 - - 添加各供应商的 API 密钥（例如 OpenAI、Anthropic 等） - - 更改会立即生效 +# ✨ 核心优势 - b. **手动配置**： - - 编辑项目目录中的 `.env` 文件 - - 使用以下命令重启服务： - ```sh - docker compose up -d - ``` +## 人在环路中断点: -就这么简单！点击 “New Spur” 创建工作流，或从内置模板开始。 +这些断点在达到时会暂停工作流，并在人工批准后恢复。 +它们为需要质量保证的工作流提供人工监督：在工作流继续之前验证关键输出。 -# ✨ 核心优势 +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## 节点级调试： diff --git a/README_DE.md b/README_DE.md index ba1ad66a..437ea3af 100644 --- a/README_DE.md +++ b/README_DE.md @@ -31,7 +31,8 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # 🕸️ Warum PySpur? -- 🖐️ **Drag-and-Drop**: Erstellen, Testen und iteratives Anpassen in Sekunden. +- ✅ **Testgetrieben**: Erstellen Sie Workflows, führen Sie Testfälle aus und iterieren Sie. +- 👤 **Human in the Loop**: Persistente Workflows, die auf Genehmigung oder Ablehnung des Users warten. - 🔄 **Loops**: Wiederholte Toolaufrufe mit Zwischenspeicherung. - 📤 **Datei-Upload**: Laden Sie Dateien hoch oder fügen Sie URLs ein, um Dokumente zu verarbeiten. - 📋 **Strukturierte Outputs**: UI-Editor für JSON-Schemata. @@ -45,9 +46,7 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # ⚡ Schnellstart -## Option A: Verwendung des `pyspur` Python-Pakets - -Dies ist der schnellste Weg, um loszulegen. Python 3.12 oder höher wird benötigt. +Dies ist der schnellste Weg, um loszulegen. Python 3.11 oder höher wird benötigt. 1. **PySpur installieren:** ```sh @@ -68,59 +67,18 @@ Dies ist der schnellste Weg, um loszulegen. Python 3.12 oder höher wird benöti Standardmäßig startet dies die PySpur-App unter `http://localhost:6080` mit einer SQLite-Datenbank. Wir empfehlen, in der `.env`-Datei eine PostgreSQL-Instanz-URL zu konfigurieren, um eine stabilere Erfahrung zu gewährleisten. -4. **[Optional] Bereitstellung anpassen:** - Sie können Ihre PySpur-Bereitstellung auf zwei Arten anpassen: - - a. **Über die App** (Empfohlen): - - Navigieren Sie zum Tab „API Keys“ in der App. - - Fügen Sie Ihre API-Schlüssel für verschiedene Anbieter (OpenAI, Anthropic usw.) hinzu. - - Die Änderungen werden sofort wirksam. - - b. **Manuelle Konfiguration**: - - Bearbeiten Sie die `.env`-Datei in Ihrem Projektverzeichnis. - - Es wird empfohlen, in der `.env`-Datei eine PostgreSQL-Datenbank zu konfigurieren, um mehr Zuverlässigkeit zu gewährleisten. - - Starten Sie die App mit `pyspur serve` neu. Fügen Sie `--sqlite` hinzu, falls Sie keine PostgreSQL verwenden. - -## Option B: Verwendung von Docker (Empfohlen für skalierbare, produktive Systeme) +4. **[Optional] Umgebung konfigurieren und API-Schlüssel hinzufügen:** + - **App-Oberfläche**: Navigieren Sie zum Tab „API Keys", um Anbieter-Schlüssel hinzuzufügen (OpenAI, Anthropic usw.) + - **Manuelle Konfiguration**: Bearbeiten Sie die `.env`-Datei (empfohlen: PostgreSQL konfigurieren) und starten Sie mit `pyspur serve` neu -Dies ist der empfohlene Weg für produktive Bereitstellungen: - -1. **Docker installieren:** - Installieren Sie Docker, indem Sie der offiziellen Installationsanleitung für Ihr Betriebssystem folgen: - - [Docker for Linux](https://docs.docker.com/engine/install/) - - [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/) - -2. **Ein PySpur-Projekt erstellen:** - Sobald Docker installiert ist, erstellen Sie ein neues PySpur-Projekt mit: - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - Dies wird: - - Ein neues PySpur-Projekt in einem neuen Verzeichnis namens `pyspur-project` starten. - - Die notwendigen Konfigurationsdateien einrichten. - - Die PySpur-App automatisch starten, unterstützt durch eine lokale PostgreSQL-Docker-Instanz. - -3. **Auf PySpur zugreifen:** - Öffnen Sie `http://localhost:6080` in Ihrem Browser. - -4. **[Optional] Bereitstellung anpassen:** - Sie können Ihre PySpur-Bereitstellung auf zwei Arten anpassen: - - a. **Über die App** (Empfohlen): - - Navigieren Sie zum Tab „API Keys“ in der App. - - Fügen Sie Ihre API-Schlüssel für verschiedene Anbieter (OpenAI, Anthropic usw.) hinzu. - - Die Änderungen werden sofort wirksam. +# ✨ Kernvorteile - b. **Manuelle Konfiguration**: - - Bearbeiten Sie die `.env`-Datei in Ihrem Projektverzeichnis. - - Starten Sie die Dienste mit: - ```sh - docker compose up -d - ``` +## Mensch-im-Regelkreis-Haltepunkte: -Das war's! Klicken Sie auf „New Spur“, um einen Workflow zu erstellen, oder starten Sie mit einer der Standardvorlagen. +Diese Haltepunkte pausieren den Workflow, wenn sie erreicht werden, und setzen ihn fort, sobald ein Mensch ihn genehmigt. +Sie ermöglichen menschliche Aufsicht für Workflows, die Qualitätssicherung erfordern: Überprüfen Sie kritische Ausgaben, bevor der Workflow fortgesetzt wird. -# ✨ Kernvorteile +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## Debuggen auf Node-Ebene: diff --git a/README_ES.md b/README_ES.md index 8331bbfb..b5b2170f 100644 --- a/README_ES.md +++ b/README_ES.md @@ -31,7 +31,8 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # 🕸️ ¿Por qué PySpur? -- 🖐️ **Arrastrar y Soltar**: Construye, prueba e itera en segundos. +- ✅ **Desarrollo Guiado por Pruebas**: Construye flujos de trabajo, ejecuta casos de prueba e itera. +- 👤 **Humano en el Bucle**: Flujos de trabajo persistentes que esperan aprobación o rechazo humano. - 🔄 **Bucles**: Llamadas iterativas a herramientas con memoria. - 📤 **Carga de Archivos**: Sube archivos o pega URLs para procesar documentos. - 📋 **Salidas Estructuradas**: Editor de interfaz para esquemas JSON. @@ -45,9 +46,7 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # ⚡ Inicio Rápido -## Opción A: Usando el Paquete Python `pyspur` - -Esta es la forma más rápida de comenzar. Se requiere Python 3.12 o superior. +Esta es la forma más rápida de comenzar. Se requiere Python 3.11 o superior. 1. **Instala PySpur:** ```sh @@ -68,59 +67,20 @@ Esta es la forma más rápida de comenzar. Se requiere Python 3.12 o superior. Por defecto, esto iniciará la aplicación PySpur en `http://localhost:6080` utilizando una base de datos SQLite. Se recomienda configurar una URL de instancia de Postgres en el archivo `.env` para obtener una experiencia más estable. -4. **[Opcional] Personaliza tu despliegue:** - Puedes personalizar tu despliegue de PySpur de dos maneras: - - a. **A través de la aplicación** (Recomendado): - - Navega a la pestaña de API Keys en la aplicación - - Agrega tus claves API para varios proveedores (OpenAI, Anthropic, etc.) - - Los cambios se aplican inmediatamente - - b. **Configuración Manual**: - - Edita el archivo `.env` en el directorio de tu proyecto - - Se recomienda configurar una base de datos Postgres en el archivo `.env` para mayor fiabilidad - - Reinicia la aplicación con `pyspur serve`. Agrega `--sqlite` si no estás utilizando Postgres - -## Opción B: Usando Docker (Recomendado para sistemas escalables y en producción) - -Esta es la forma recomendada para despliegues en producción: - -1. **Instala Docker:** - Primero, instala Docker siguiendo la guía oficial de instalación para tu sistema operativo: - - [Docker para Linux](https://docs.docker.com/engine/install/) - - [Docker Desktop para Mac](https://docs.docker.com/desktop/install/mac-install/) - -2. **Crea un Proyecto PySpur:** - Una vez instalado Docker, crea un nuevo proyecto PySpur con: - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - Esto: - - Iniciará un nuevo proyecto PySpur en un directorio llamado `pyspur-project` - - Configurará los archivos de configuración necesarios - - Iniciará la aplicación PySpur automáticamente, respaldada por una instancia local de Postgres en Docker +4. **[Opcional] Configura tu entorno y añade claves API:** + - **A través de la interfaz de la aplicación**: Navega a la pestaña de API Keys para añadir claves de proveedores (OpenAI, Anthropic, etc.) + - **Configuración manual**: Edita el archivo `.env` (recomendado: configura postgres) y reinicia con `pyspur serve` -3. **Accede a PySpur:** - Ve a `http://localhost:6080` en tu navegador. - -4. **[Opcional] Personaliza tu despliegue:** - Puedes personalizar tu despliegue de PySpur de dos maneras: +¡Eso es todo! Haz clic en "New Spur" para crear un flujo de trabajo, o comienza con una de las plantillas predefinidas. - a. **A través de la aplicación** (Recomendado): - - Navega a la pestaña de API Keys en la aplicación - - Agrega tus claves API para varios proveedores (OpenAI, Anthropic, etc.) - - Los cambios se aplican inmediatamente +# ✨ Beneficios Principales - b. **Configuración Manual**: - - Edita el archivo `.env` en el directorio de tu proyecto - - Reinicia los servicios con: - ```sh - docker compose up -d - ``` +## Puntos de Interrupción con Humano en el Bucle: -¡Eso es todo! Haz clic en "New Spur" para crear un flujo de trabajo, o comienza con una de las plantillas predefinidas. +Estos puntos de interrupción pausan el flujo de trabajo cuando se alcanzan y lo reanudan tan pronto como un humano lo aprueba. +Permiten la supervisión humana para flujos de trabajo que requieren garantía de calidad: verifique las salidas críticas antes de que el flujo de trabajo continúe. -# ✨ Beneficios Principales +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## Depuración a Nivel de Nodo: diff --git a/README_FR.md b/README_FR.md index 94fa9059..67aa6b57 100644 --- a/README_FR.md +++ b/README_FR.md @@ -31,23 +31,22 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # 🕸️ Pourquoi PySpur ? -- 🖐️ **Glisser-déposer** : Créez, testez et itérez en quelques secondes. -- 🔄 **Boucles** : Appels d’outils itératifs avec mémoire. +- ✅ **Piloté par les tests** : Construisez des workflows, exécutez des cas de test et itérez. +- 👤 **Humain dans la boucle** : Workflows persistants qui attendent l'approbation ou le rejet humain. +- 🔄 **Boucles** : Appels d'outils itératifs avec mémoire. - 📤 **Téléversement de fichiers** : Téléchargez des fichiers ou collez des URL pour traiter des documents. -- 📋 **Sorties structurées** : Éditeur d’interface utilisateur pour les schémas JSON. +- 📋 **Sorties structurées** : Éditeur d'interface utilisateur pour les schémas JSON. - 🗃️ **RAG** : Analyser, découper, intégrer et insérer ou mettre à jour des données dans une base de données vectorielle. - 🖼️ **Multimodal** : Support pour vidéos, images, audio, textes, code. - 🧰 **Outils** : Slack, Firecrawl.dev, Google Sheets, GitHub, et plus encore. - 🧪 **Évaluations** : Évaluez les agents sur des ensembles de données réelles. -- 🚀 **Déploiement en un clic** : Publiez en tant qu’API et intégrez-le où vous le souhaitez. +- 🚀 **Déploiement en un clic** : Publiez en tant qu'API et intégrez-le où vous le souhaitez. - 🐍 **Basé sur Python** : Ajoutez de nouveaux nœuds en créant un seul fichier Python. - 🎛️ **Support multi-fournisseurs** : >100 fournisseurs de LLM, intégrateurs et bases de données vectorielles. # ⚡ Démarrage rapide -## Option A : Utiliser le package Python `pyspur` - -C'est la manière la plus rapide de commencer. Python 3.12 ou une version supérieure est requis. +C'est la manière la plus rapide de commencer. Python 3.11 ou une version supérieure est requis. 1. **Installer PySpur :** ```sh @@ -68,58 +67,20 @@ C'est la manière la plus rapide de commencer. Python 3.12 ou une version supér Par défaut, cela démarrera l'application PySpur sur `http://localhost:6080` en utilisant une base de données SQLite. Nous vous recommandons de configurer une URL d'instance Postgres dans le fichier `.env` pour une expérience plus stable. -4. **[Optionnel] Personnaliser votre déploiement :** - Vous pouvez personnaliser votre déploiement PySpur de deux façons : - - a. **Via l'application** (Recommandé) : - - Naviguez vers l'onglet des clés API dans l'application - - Ajoutez vos clés API pour divers fournisseurs (OpenAI, Anthropic, etc.) - - Les modifications prennent effet immédiatement - - b. **Configuration manuelle** : - - Éditez le fichier `.env` dans le répertoire de votre projet - - Il est recommandé de configurer une base de données Postgres dans le fichier `.env` pour une meilleure fiabilité - - Redémarrez l'application avec `pyspur serve`. Ajoutez `--sqlite` si vous n'utilisez pas Postgres - -## Option B : Utiliser Docker (Recommandé pour des systèmes évolutifs en production) - -C'est la méthode recommandée pour les déploiements en production : - -1. **Installer Docker :** - Tout d'abord, installez Docker en suivant le guide d'installation officiel pour votre système d'exploitation : - - [Docker pour Linux](https://docs.docker.com/engine/install/) - - [Docker Desktop pour Mac](https://docs.docker.com/desktop/install/mac-install/) - -2. **Créer un projet PySpur :** - Une fois Docker installé, créez un nouveau projet PySpur avec : - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - Cela va : - - Démarrer un nouveau projet PySpur dans un nouveau répertoire nommé `pyspur-project` - - Configurer les fichiers de configuration nécessaires - - Démarrer automatiquement l'application PySpur avec une instance Docker Postgres locale +4. **[Optionnel] Configurer votre environnement et ajouter des clés API :** + - **Via l'interface de l'application** : Naviguez vers l'onglet des clés API pour ajouter des clés de fournisseurs (OpenAI, Anthropic, etc.) + - **Configuration manuelle** : Éditez le fichier `.env` (recommandé : configurez postgres) et redémarrez avec `pyspur serve` -3. **Accéder à PySpur :** - Allez sur `http://localhost:6080` dans votre navigateur. - -4. **[Optionnel] Personnaliser votre déploiement :** +C'est tout ! Cliquez sur « New Spur » pour créer un workflow, ou commencez avec l'un des modèles de base. - a. **Via l'application** (Recommandé) : - - Naviguez vers l'onglet des clés API dans l'application - - Ajoutez vos clés API pour divers fournisseurs (OpenAI, Anthropic, etc.) - - Les modifications prennent effet immédiatement +# ✨ Avantages principaux - b. **Configuration manuelle** : - - Éditez le fichier `.env` dans le répertoire de votre projet - - Redémarrez les services avec : - ```sh - docker compose up -d - ``` +## Points d'arrêt avec humain dans la boucle : -C'est tout ! Cliquez sur « New Spur » pour créer un workflow, ou commencez avec l'un des modèles de base. +Ces points d'arrêt mettent en pause le flux de travail lorsqu'ils sont atteints et le reprennent dès qu'un humain l'approuve. +Ils permettent une supervision humaine pour les flux de travail nécessitant une assurance qualité : vérifiez les sorties critiques avant que le flux de travail ne continue. -# ✨ Avantages principaux +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## Déboguer au niveau des nœuds : diff --git a/README_JA.md b/README_JA.md index 8491d477..7192d6f5 100644 --- a/README_JA.md +++ b/README_JA.md @@ -29,9 +29,10 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe -# 🕸️ なぜ PySpur なのか？ +# ��️ なぜ PySpur なのか？ -- 🖐️ **ドラッグ＆ドロップ**: 数秒で構築、テスト、反復できます。 +- ✅ **テスト駆動型**: ワークフローを構築し、テストケースを実行し、反復します。 +- 👤 **ヒューマンインザループ**: 人間の承認または拒否を待つ永続的なワークフロー。 - 🔄 **ループ**: メモリを活用した反復的なツール呼び出し。 - 📤 **ファイルアップロード**: ファイルのアップロードやURLの貼り付けによりドキュメントを処理します。 - 📋 **構造化された出力**: JSONスキーマ用のUIエディタ。 @@ -45,9 +46,7 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # ⚡ クイックスタート -## オプション A: `pyspur` Pythonパッケージの使用 - -これは最も迅速なスタート方法です。Python 3.12以上が必要です。 +これは最も迅速なスタート方法です。Python 3.11以上が必要です。 1. **PySpurのインストール:** ```sh @@ -67,57 +66,18 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe ``` デフォルトでは、SQLiteデータベースを使用して `http://localhost:6080` でPySpurアプリが起動します。より安定した動作を求める場合は、`.env`ファイルにPostgresのインスタンスURLを設定することを推奨します。 -4. **[オプション] デプロイのカスタマイズ:** - PySpurのデプロイは以下の2通りの方法でカスタマイズできます： - - a. **アプリ内から** (推奨): - - アプリ内の「APIキー」タブに移動する - - 各種プロバイダー（OpenAI、Anthropicなど）のAPIキーを追加する - - 変更は即座に反映される - - b. **手動設定**: - - プロジェクトディレクトリ内の `.env` ファイルを編集する - - より信頼性を高めるために、`.env`でPostgresデータベースを設定することを推奨 - - `pyspur serve` でアプリを再起動する。Postgresを使用していない場合は `--sqlite` を追加する - -## オプション B: Dockerの利用（スケーラブルな本番システム向けに推奨） - -本番環境でのデプロイにはこちらの方法を推奨します： - -1. **Dockerのインストール:** - まず、お使いのOSに合わせた公式インストールガイドに従い、Dockerをインストールしてください： - - [Docker for Linux](https://docs.docker.com/engine/install/) - - [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/) +4. **[オプション] 環境設定とAPIキーの追加:** + - **アプリUI**: APIキータブに移動して各プロバイダーのキー（OpenAI、Anthropicなど）を追加 + - **手動設定**: `.env`ファイルを編集（推奨：postgresを設定）し、`pyspur serve`で再起動 -2. **PySpurプロジェクトの作成:** - Dockerをインストールしたら、以下のコマンドで新しいPySpurプロジェクトを作成します： - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - このコマンドは以下の処理を行います： - - `pyspur-project` という新しいディレクトリ内にPySpurプロジェクトを作成 - - 必要な設定ファイルを構成 - - ローカルのPostgres Dockerインスタンスをバックエンドに、PySpurアプリを自動で起動 - -3. **PySpurへのアクセス:** - ブラウザで `http://localhost:6080` にアクセスしてください。 - -4. **[オプション] デプロイのカスタマイズ:** - a. **アプリ内から** (推奨): - - アプリ内の「APIキー」タブに移動する - - 各種プロバイダー（OpenAI、Anthropicなど）のAPIキーを追加する - - 変更は即座に反映される +# ✨ 主な利点 - b. **手動設定**: - - プロジェクトディレクトリ内の `.env` ファイルを編集する - - 以下のコマンドでサービスを再起動する： - ```sh - docker compose up -d - ``` +## ヒューマンインザループブレークポイント: -以上です！「New Spur」をクリックしてワークフローを作成するか、標準テンプレートから開始してください。 +これらのブレークポイントは到達時にワークフローを一時停止し、人間が承認するとすぐに再開します。 +品質保証が必要なワークフローに人間の監視を可能にします：ワークフローが進む前に重要な出力を検証します。 -# ✨ 主な利点 +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## ノードレベルでのデバッグ: diff --git a/README_KR.md b/README_KR.md index 5b72350b..3ed03b2f 100644 --- a/README_KR.md +++ b/README_KR.md @@ -31,7 +31,8 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # 🕸️ 왜 PySpur인가? -- 🖐️ **드래그 앤 드롭**: 몇 초 안에 구축, 테스트 및 반복 진행. +- ✅ **테스트 주도**: 워크플로우를 구축하고, 테스트 케이스를 실행하며, 반복합니다. +- 👤 **인간 참여 루프**: 인간의 승인 또는 거부를 기다리는 지속적인 워크플로우. - 🔄 **루프**: 메모리를 활용한 반복적 도구 호출. - 📤 **파일 업로드**: 파일을 업로드하거나 URL을 붙여넣어 문서를 처리. - 📋 **구조화된 출력**: JSON 스키마용 UI 편집기. @@ -45,9 +46,7 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe # ⚡ 빠른 시작 -## 옵션 A: `pyspur` 파이썬 패키지 사용 - -시작하는 가장 빠른 방법입니다. 파이썬 3.12 이상이 필요합니다. +시작하는 가장 빠른 방법입니다. 파이썬 3.11 이상이 필요합니다. 1. **PySpur 설치:** ```sh @@ -68,59 +67,18 @@ https://github.com/user-attachments/assets/1ebf78c9-94b2-468d-bbbb-566311df16fe 기본적으로 SQLite 데이터베이스를 사용하여 `http://localhost:6080`에서 PySpur 앱이 시작됩니다. 보다 안정적인 사용을 위해 `.env` 파일에 PostgreSQL 인스턴스 URL을 설정하는 것을 권장합니다. -4. **[선택 사항] 배포 맞춤 설정:** - PySpur 배포는 두 가지 방법으로 맞춤 설정할 수 있습니다: - - a. **앱을 통한 설정** (권장): - - 앱의 API 키 탭으로 이동 - - 다양한 제공업체(OpenAI, Anthropic 등)의 API 키를 추가 - - 변경 사항이 즉시 적용됨 - - b. **수동 설정:** - - 프로젝트 디렉토리 내의 `.env` 파일을 수정 - - 보다 안정적인 사용을 위해 `.env` 파일에 PostgreSQL 데이터베이스 설정을 권장 - - PostgreSQL을 사용하지 않을 경우 `--sqlite` 옵션을 추가하여 `pyspur serve` 명령어로 앱을 재시작 - -## 옵션 B: Docker 사용 (확장 가능, 운영 환경에 적합) +4. **[선택 사항] 환경 구성 및 API 키 추가:** + - **앱 UI**: API 키 탭으로 이동하여 공급자 키(OpenAI, Anthropic 등) 추가 + - **수동 구성**: `.env` 파일 편집(권장: postgres 구성) 후 `pyspur serve`로 재시작 -운영 환경 배포에 권장되는 방법입니다: - -1. **Docker 설치:** - 먼저, 사용 중인 운영 체제에 맞는 공식 설치 가이드를 따라 Docker를 설치하세요: - - [Docker for Linux](https://docs.docker.com/engine/install/) - - [Docker Desktop for Mac](https://docs.docker.com/desktop/install/mac-install/) - -2. **PySpur 프로젝트 생성:** - Docker 설치 후, 다음 명령어로 새로운 PySpur 프로젝트를 생성합니다: - ```sh - curl -fsSL https://raw.githubusercontent.com/PySpur-com/pyspur/main/start_pyspur_docker.sh | bash -s pyspur-project - ``` - 이 명령어는: - - `pyspur-project`라는 새 디렉토리에서 PySpur 프로젝트를 시작하고, - - 필요한 구성 파일들을 설정하며, - - 로컬 PostgreSQL Docker 인스턴스를 백엔드로 하여 PySpur 앱을 자동으로 시작합니다. - -3. **PySpur 접속:** - 브라우저에서 `http://localhost:6080`으로 접속합니다. - -4. **[선택 사항] 배포 맞춤 설정:** - PySpur 배포는 두 가지 방법으로 맞춤 설정할 수 있습니다: - - a. **앱을 통한 설정** (권장): - - 앱의 API 키 탭으로 이동 - - 다양한 제공업체(OpenAI, Anthropic 등)의 API 키를 추가 - - 변경 사항이 즉시 적용됨 +# ✨ 핵심 이점 - b. **수동 설정:** - - 프로젝트 디렉토리 내의 `.env` 파일을 수정 - - 다음 명령어로 서비스를 재시작: - ```sh - docker compose up -d - ``` +## 인간 참여 중단점: -이제 끝입니다! "New Spur"을 클릭하여 워크플로우를 생성하거나 기본 템플릿 중 하나로 시작하세요. +이러한 중단점은 도달했을 때 워크플로우를 일시 중지하고 인간이 승인하면 재개됩니다. +품질 보증이 필요한 워크플로우에 인간의 감독을 가능하게 합니다: 워크플로우가 진행되기 전에 중요한 출력을 검증합니다. -# ✨ 핵심 이점 +https://github.com/user-attachments/assets/98cb2b4e-207c-4d97-965b-4fee47c94ce8 ## 노드 레벨에서 디버그: