Oldman

Oldman 是后端渲染优先的 Python 应用框架，适合构建 Dashboard、管理后台、Web/API 服务和后台任务服务。

Python 负责配置、应用生命周期、权限、数据和 HTML；浏览器端负责局部更新、表单提交、表格、弹窗和实时交互。你可以只写后端，也可以为需要交互的页面增加 TypeScript。

两个包各有职责：

内置 Admin 和业务 Dashboard 使用同一套组件、样式与响应协议，不需要分别维护两套前端。

从哪里开始

• 用户文档：安装、创建项目和实际使用。
• 开发者参考：准确的接口、加载顺序和扩展方法。
• Agent 应用开发指南：按任务选择文件、完成接线与验证。
• 文档总入口：按问题查找正文。

初次使用可先运行 EPG Dashboard Demo，再对照其真实数据和表格、Modal 表单。教程直接使用 Demo 代码，给出源文件、运行目录、配置和预期结果；更多页面见示例索引。

最短的项目入口

使用与你要开发的版本对应的 oldman 包。在发行包可用的环境中安装后执行：

oldman startproject my_site

命令会询问项目类型和数据库。选择 api、none 后，在新项目目录执行：

cd my_site
uv sync
./run.sh api settings sync
./run.sh api start

此时启动的是尚未添加业务路由的服务；/ 返回 404 是正常结果。添加 API 的接线见服务创建指南；要直接查看完整业务页面则运行上面的 Demo。

run.sh 只把原样参数交给项目 .venv 中的 oldman，不替你选服务、迁移数据库或启动前端。./run.sh api start 与使用同一虚拟环境运行 oldman api start 的语义相同。上面是新建空项目的命令，不是 Demo 启动步骤；Demo 的独立安装与调试见运行环境与安装。

框架提供什么

• 应用组织：一个项目可包含多个服务；每个服务读取自己的 YAML，并显式安装需要的 App。App 可提供模型、视图、自定义命令和强类型配置。
• Web 与数据：基于 Sanic 的异步服务、Jinja HTML、SQLAlchemy 模型、项目级 Alembic 命令、Auth 与 Admin。
• 页面交互：后端 Form、HTML/JSON Table，前端 Form/Modal/Feedback/Select/Chart 等共享组件，以及有序的 JSON 响应动作。
• 消息：Cookie 一次性页面提示、数据库持久通知、临时实时推送、通用 SSE 浏览器投递；进程控制消息有独立职责。
• 基础能力：文件存储、HTTP Client、缓存、Redis/NATS provider、日志、短生命周期子进程和持久 Worker。
• 持久任务：Taskiq + NATS JetStream + Redis，支持异步函数投递、多个执行进程、结果、广播和定时计划；与固定本地 Worker、Core NATS 事件/RPC 分开使用。

普通 API 不要求安装前端包。需要共享 Dashboard UI 时再安装 oldman-web 及其声明的依赖；内置 Admin 的默认浏览器资源随 Python 包提供。

当前运行目标为 Linux，Python 版本范围为 >=3.12,<3.14。SQLite 驱动随 Python 包安装；MySQL、PostgreSQL 驱动按项目需要声明。配置中存在 Redis 连接项不代表启动就连接 Redis，启用或调用相应能力时才需要可用的服务。

完整示例

• Admin Demo：内置后台的独立应用。
• EPG Dashboard Demo：业务 Dashboard、UI 与功能示例。

示例是独立 Git 仓库，各有配置、虚拟环境、前端依赖和数据库。具体运行步骤以各示例的 README 为准，不在框架目录内安装它们。

源码布局

oldman/                       Python 框架和随包资源
frontend/packages/oldman-web/  浏览器包
frontend/apps/admin/          内置 Admin 的前端源码
examples/snippets/            局部用法片段，不是完整应用
tests/                        Python 测试
scripts/                      维护和验证工具
docs/                         用户、开发者与 Agent 文档

Python 和 npm 包不包含独立 Demo 的业务代码与运行数据。框架仓库不是业务项目，不在根目录添加应用的 config/、services/ 或数据库。

产品取舍见 PRODUCT.md，参与本仓库工作前请读 AGENTS.md。