From 5f7e5838bcf362e5c70648e09f9299af2007e718 Mon Sep 17 00:00:00 2001 From: wangyunlong <3080433063@qq.com> Date: Tue, 28 Jul 2026 14:56:04 +0800 Subject: [PATCH] docs: describe gyxx-flow as a standalone project --- README.md | 41 ++++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d2c1103..ac3f0f4 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ # GYXX Flow -GYXX Flow 将原来分散在四个项目中的定时工作流和可执行脚本迁入一个可安装、可迁移的模块化项目： +GYXX Flow 是面向业务自动化的模块化工作流平台，统一管理数据采集、经营分析、供应链处理、定时调度和外部系统集成。 - `content_marketing`：内容与营销采集 - `product_commerce`：商品、平台和经营分析 - `shop_intelligence`：店铺与竞店采集 - `supply_chain`：供应链采集与通知 -运行时源码全部位于 `src/gyxx_flow/modules//runtime`。新项目不会从 -`D:\yingxiaoyunying`、`D:\shop-data-flow`、`D:\product-collector-analyze-flow` -或 `E:\auto-flow` 导入或启动代码；这些旧项目仅保留为只读迁移来源和回滚基线。 +项目采用模块化单体结构。框架能力位于 `src/gyxx_flow`，各业务模块运行时代码位于 +`src/gyxx_flow/modules//runtime`。工作流、脚本、数据目录和外部系统配置均由 +统一入口管理，同时保持模块间高内聚、低耦合。 + +## 核心能力 + +- 声明式工作流目录、依赖编排、超时、重试和失败恢复 +- 计划任务生成、漂移检查和逐任务部署 +- 手工执行、定时执行、日期回填、dry-run 和 shadow 模式 +- 每次运行使用稳定的 `run_id`，记录步骤状态、日志、产物和外部写入 +- JSON、Markdown、CSV、Excel、下载文件和截图统一分层存储 +- 每个浏览器脚本独立 CDP 端口、Profile、Cookie 和 storage state +- 飞书、云端 PostgreSQL、本机 Hermes 和浏览器能力统一接入 ## 安装与验证 @@ -32,9 +42,9 @@ uv run gyxx run product.daily --date 2026-07-27 --execute ``` `run`、`backfill` 和 `scripts run` 默认都是无副作用 dry-run；只有显式加 -`--execute` 才会启动迁入后的本地脚本。 +`--execute` 才会启动项目内的业务脚本。 -## 运行任意迁入脚本 +## 运行任意脚本 ```powershell uv run gyxx scripts list @@ -59,13 +69,13 @@ PowerShell 入口均受统一项目根、数据根、业务日期、run_id 和 s ## 数据目录 -默认数据根为 `D:\gyxx-flow\var`，可用 `GYXX_DATA_ROOT` 迁移到其他磁盘。 +默认数据根为 `D:\gyxx-flow\var`，可用 `GYXX_DATA_ROOT` 配置到其他磁盘或服务器目录。 业务数据按模块写入 `data/raw`、`data/normalized`、`data/curated`、`data/exports` 和 `data/evidence`；运行状态、日志和临时文件分别进入 `state`、`logs` 和 `tmp`。 原始 JSON/CSV/XLS/XLSX/下载文件进 raw，清洗结果进 normalized，聚合数据进 curated， 最终 Markdown/Excel 报告进 exports。浏览器 Profile、Cookie 和 storage state 位于 -`state/browser//