Merge pull request #5 from pymss-project/server

Server

Author: baicai-1145

.github/workflows/release.yml

@@ -22,6 +22,21 @@ jobs:
         with:
           python-version: "3.11"
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: webui/package-lock.json
+
+      - name: Install WebUI dependencies
+        run: npm ci
+        working-directory: webui
+
+      - name: Build WebUI static assets
+        run: npm run build
+        working-directory: webui
+
       - name: Install build tools
         run: python -m pip install --upgrade pip build twine
 

.github/workflows/webui-assets.yml

@@ -0,0 +1,50 @@
+name: WebUI Assets
+
+on:
+  pull_request:
+    paths:
+      - "webui/**"
+      - "pymss/server/webui_static/**"
+      - ".github/workflows/webui-assets.yml"
+  push:
+    branches:
+      - "**"
+    paths:
+      - "webui/**"
+      - "pymss/server/webui_static/**"
+      - ".github/workflows/webui-assets.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  check-webui-assets:
+    name: Check generated WebUI assets
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: webui/package-lock.json
+
+      - name: Install WebUI dependencies
+        run: npm ci
+        working-directory: webui
+
+      - name: Build WebUI static assets
+        run: npm run build
+        working-directory: webui
+
+      - name: Check generated assets are committed
+        run: |
+          if ! git diff --exit-code -- pymss/server/webui_static; then
+            echo "::error::WebUI static assets are out of date. Run 'npm ci && npm run build' in webui and commit pymss/server/webui_static/."
+            exit 1
+          fi

.gitignore

@@ -51,6 +51,11 @@ coverage.xml
 .pytest_cache/
 cover/
 
+# Node / frontend
+webui/node_modules/
+!webui/src/lib/
+!webui/src/lib/**
+
 # Translations
 *.mo
 *.pot
@@ -184,4 +189,4 @@ pretrain
 resources
 tmp
 all_models
-/mps/
+/mps/

README.md

@@ -56,6 +56,17 @@ pymss --model-dir /path/to/models infer bs_roformer_voc_hyperacev2 \
 
 When running from a source checkout without installation, use `python -m pymss.cli` instead of `pymss`.
 
+### Server and WebUI
+
+Install the optional server dependencies to run a HTTP server with dynamic model loading, catalog browsing, model downloads, and an optional browser WebUI:
+
+```sh
+pip install "pymss[server]"
+pymss serve --webui
+```
+
+See [server CLI docs](./docs/server/cli.md), [server API docs](./docs/server/api.md), and [server error docs](./docs/server/errors.md) for details.
+
 ### Python API
 
 Use a catalog model name directly. You do not need to pass `model_type`, `model_path`, or `config_path`.

README_CN.md

@@ -51,6 +51,17 @@ pymss --model-dir /path/to/models infer bs_roformer_voc_hyperacev2 \
 
 如果是在源码目录里未安装运行，可以用 `python -m pymss.cli` 代替 `pymss`。
 
+### Server 和 WebUI
+
+安装可选 server 依赖后，可以启动 HTTP server，支持动态加载模型、浏览 catalog、下载模型文件，以及可选的浏览器 WebUI：
+
+```sh
+pip install "pymss[server]"
+pymss serve --webui
+```
+
+详细用法见 [server CLI 文档](./docs/server/cli.md)、[server API 文档](./docs/server/api.md) 和 [server 错误文档](./docs/server/errors.md)。
+
 ### Python API
 
 直接用 catalog 里的模型名即可，不需要传 `model_type`、`model_path`、`config_path`。