feat: update clients and servers

quanttide · Nov 29, 2023 · 1ed6017 · 1ed6017
1 parent 97e5917
commit 1ed6017
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 8 deletions.
diff --git a/_toc.yml b/_toc.yml
@@ -1,5 +1,15 @@
 format: jb-book
 root: index.md
-chapters:
-  - file: general.md
-  - file: web_server/README.md
+parts:
+  - caption: 原则
+    chapters:
+      - file: principles/README.md
+  - caption: 客户端
+    chapters:
+      - file: sdk/README.md
+        sections: 
+          - file: sdk/api_client.md
+      - file: cli/README.md
+  - caption: 服务端
+    chapters:
+      - file: server/README.md
diff --git a/cli/README.md b/cli/README.md
@@ -0,0 +1,4 @@
+# 命令行工具
+
+使用[`typer`](https://typer.tiangolo.com)作为主要的命令行开发框架。
+标准库`argparse`（`optparse`已废弃）、第三方库`click`等作为备选框架。
diff --git a/general.md → principles/README.md b/general.md → principles/README.md
@@ -1,4 +1,4 @@
-# 基本规则
+# 原则
 
 ## 项目结构
 

diff --git a/sdk/README.md b/sdk/README.md
@@ -1,4 +1,4 @@
-# 云SDK类Python依赖
+# SDK
 
 ## 预期特性
 

diff --git a/server/README.md b/server/README.md
@@ -0,0 +1,3 @@
+# 服务端
+
+使用FastAPI作为首选框架。Django和Flask作为备选框架。
diff --git a/web_server/README.md b/web_server/README.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# 服务端

		使用FastAPI作为首选框架。Django和Flask作为备选框架。