增加 pypi uv 部署

配合 NJUPT Suan API v0.1.1 更新一下文档的基本内容~
This commit is contained in:
2026-04-26 00:49:50 +08:00
parent 5b2e276918
commit 332e186014
4 changed files with 51 additions and 120 deletions

View File

@@ -2,12 +2,45 @@
酸 API 同时具备 API 和 MCP 后端的功能。因此,酸 API 不支持 stdio 格式的 MCP 调用。
## cli 命令
NJUPT Suan API 现在拥有一个 cli 命令行,可以作为入口以及管理工具。在设计上,这个命令行工具叫做 `suanapi`
|命令|简介|
|--|--|
|init|初始化 NJUPT Suan API包括创建工作目录、创建配置文件以及下载 playwright chromium|
|token|显示以及生成新的管理后端令牌|
|run|运行 NJUPT Suan API支持传入 host port reload 参数|
cli 拥有完整的帮助文档,你可以使用 `--help` 查看。
## 部署 Suan API 示例
目前的 Suan API 在设计上即不允许(或者说不适合)公开部署、公共服务,因此你需要自行部署 Suan API 实例。
### 使用 uv 部署
芒果计划把 NJUPT Suan API 做成一个 uv 工具,但现在看来好像还存在一些问题。
你现在可以将 NJUPT Suan API 作为一个依赖安装然后使用命令行启动。NJUPT Suan API 已经发布至 pypi。
```bash
# 初始化 uv 项目
uv init -p 3.13
# 安装
uv add njupt-suan-api
# 初始化 NJUPT Suan API
# 只需要首次运行前初始化一次即可
uv run suanapi init -f
# 运行
uv run suanapi run
```
初始化时需要加上 `-f` 是一个技术性妥协,芒果需要研究一些更优雅的解决方法。不过目前是可以使用的,芒果已经在 Windows 和 Linux 上做过测试了~
### 使用 Docker 部署
### 从源码部署