videoflow

环境要求

• Python 3.12 或更高版本
• Docker（用于 run-local 自动启动开发 NATS 容器）
• 运行时需要 NATS JetStream 服务器，run-local 会自动启动一个
• 可用的 pip 环境（从 PyPI 安装）

安装与启动步骤

1. 1检查运行环境

   确认本机 Python 版本不低于 3.12，并已安装并启动 Docker；两者是 run-local 正常工作的前提。

   python --version
   docker info

   复制

2. 2安装 videoflow

   从 PyPI 安装带全部可选依赖的版本，建议装进自己独立的虚拟环境，避免依赖冲突。

   pip install -U 'videoflow[all]'

   复制

3. 3准备 NATS 服务器

   没有 Docker 时需自己起一个 JetStream 服务；有 Docker 时可跳过，run-local 会自动拉起开发 broker。

   nats-server -js

   复制

4. 4编写流水线脚本

   在 build_flow() 里用生产者、处理器、消费者连成有向无环图，Flow 只列叶子消费者，生产者会自动发现。

   cat > my_flow.py <<'EOF'
   from videoflow.core import Flow
   from videoflow.core.constants import BATCH
   from videoflow.producers import IntProducer
   from videoflow.processors import IdentityProcessor, JoinerProcessor
   from videoflow.consumers import CommandlineConsumer
   
   def build_flow():
       producer  = IntProducer(0, 40, 0.1, name='producer')
       identity  = IdentityProcessor(name='identity')(producer)
       identity1 = IdentityProcessor(name='identity1')(identity)
       joined    = JoinerProcessor(name='joined')(identity, identity1)
       printer   = CommandlineConsumer(name='printer')(joined)
       return Flow([printer], flow_type=BATCH)
   
   if __name__ == '__main__':
       from videoflow.engines.local import LocalProcessEngine
       flow = build_flow()
       flow.run(LocalProcessEngine())
       flow.join()
   EOF

   复制

5. 5本地运行流水线

   run-local 会为每个节点拉起一个子进程，等待流程结束后报告非零退出的节点，并只清理它自己启动的容器。

   videoflow run-local my_flow.py

   复制

6. 6直接运行脚本

   如果已有可用的消息代理，可以直接执行脚本，不经过 run-local 的编排逻辑。

   python my_flow.py

   复制

7. 7部署到 Kubernetes

   在 k3s、kind、minikube 或 Docker Desktop 等开发集群上，一条命令编译图、构建镜像并渲染每个节点的工作负载。

   videoflow deploy my_flow.py

   复制

关键配置

如何确认成功

run-local 输出中每个节点各有一个工作子进程启动，命令行消费者正常打印数据，流程结束后没有节点以非零状态退出。

常见问题

注意事项

• Python 版本要求 3.12+，低版本无法安装。
• run-local 只停止它自己启动的容器；自建的开发存储会保留上次失败运行留下的数据（批处理流 TTL 为 24 小时）。
• 部署时若图旁存在 Dockerfile（或 gpu.Dockerfile）会被构建使用，否则使用对应版本的 videoflow 基础镜像，可用 --image 覆盖。
• 本地图文件可通过可重复的 --mount /abs/path[:ro] 暴露给 Pod，集群内数据用 --mount-pvc claim:/path[:ro] 挂载。