update Readmes

PySpur-Dev · Mar 3, 2025 · 767374c · 767374c
1 parent ae39595
commit 767374c
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 315 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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 :