aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-03-12 09:09:48 +0800
committer简律纯 <i@jyunko.cn>2024-03-12 09:09:48 +0800
commit91ebc76aec7ace1189d9a2386e167de0e080fc77 (patch)
tree5c2d64f6bd162b6c7896984be3488dd85eb8d0b2
parentb29525ed8278327accda42ac6c787db5cd604fab (diff)
downloadHydroRollCore-99.99.99.tar.gz
HydroRollCore-99.99.99.zip
chore(filetree): complete framework design for corev99.99.99
-rw-r--r--.vscode/settings.json2
-rw-r--r--README.rst28
-rw-r--r--hydro_roll_core/__init__.py5
-rw-r--r--hydro_roll_core/cli.py0
-rw-r--r--hydro_roll_core/config.py0
-rw-r--r--hydro_roll_core/const.py0
-rw-r--r--hydro_roll_core/dependencies.py0
-rw-r--r--hydro_roll_core/dev/__init__.py0
-rw-r--r--hydro_roll_core/docs/__init__.py0
-rw-r--r--hydro_roll_core/exceptions.py0
-rw-r--r--hydro_roll_core/features/__init__.py0
-rw-r--r--hydro_roll_core/log.py0
-rw-r--r--hydro_roll_core/performance/__init__.py0
-rw-r--r--hydro_roll_core/py.typed0
-rw-r--r--hydro_roll_core/rule_package.py0
-rw-r--r--hydro_roll_core/typing.py0
-rw-r--r--hydro_roll_core/utils.py0
17 files changed, 29 insertions, 6 deletions
diff --git a/.vscode/settings.json b/.vscode/settings.json
index f2907a5..73dc9f3 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,3 +1,3 @@
{
- "restructuredtext.preview.name": "sphinx"
+ "restructuredtext.preview.name": "docutils"
} \ No newline at end of file
diff --git a/README.rst b/README.rst
index 98a346c..2db9052 100644
--- a/README.rst
+++ b/README.rst
@@ -8,7 +8,7 @@
HydroRoll-Core <=> 水系核心
-==========================
+===========================
去中心化应用程序。
@@ -25,6 +25,32 @@ HydroRoll-Core <=> 水系核心
- 📚 *PDF* 生成,结合自定义 *PDF* 模板,能够生成符合需求的 *PDF* 书籍。
- 🌏 离线文档与在线协作站点,使用 *Sphinx* 框架与 *Vue* 技术栈生成本地文档与在线站点。
+架构设计
+--------
+
+核心模块 ``corelib``
+
+包含 *CLI* 界面,用于单独使用。
+包含 *REST API* 和 *WebSocket* 通信模块,以便其他语言能够接入和与之交互。
+集成请求处理模块,确保能够处理大量请求。
+
+规则包加载模块 ``Rule Pack Loading Module``
+
+负责读取约定式的规则包。
+利用并行处理技术,可通过Rust实现以提高性能。
+
+PDF生成模块 ``PDF Generation Module``
+
+将规则包作为输入,结合高度自定义的PDF模板,生成符合要求的PDF书籍。
+
+文档站点生成模块 ``Documentation Site Generation Module``
+
+使用Sphinx框架生成本地在线文档站点。
+
+其他功能模块 ``Other Feature Modules``
+
+包括尚未确定的其他功能,如文档生成、数据分析等。
+
----
`AGPL3.0`_ © 2023-PRESENT `简律纯`_ & `HydroRoll-Team`_.
diff --git a/hydro_roll_core/__init__.py b/hydro_roll_core/__init__.py
index 4740127..0a04e23 100644
--- a/hydro_roll_core/__init__.py
+++ b/hydro_roll_core/__init__.py
@@ -1,4 +1 @@
-from . import corelib
-
-def sum_words(a: str, b: str) -> str:
- return a + b \ No newline at end of file
+from . import corelib \ No newline at end of file
diff --git a/hydro_roll_core/cli.py b/hydro_roll_core/cli.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/cli.py
diff --git a/hydro_roll_core/config.py b/hydro_roll_core/config.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/config.py
diff --git a/hydro_roll_core/const.py b/hydro_roll_core/const.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/const.py
diff --git a/hydro_roll_core/dependencies.py b/hydro_roll_core/dependencies.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/dependencies.py
diff --git a/hydro_roll_core/dev/__init__.py b/hydro_roll_core/dev/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/dev/__init__.py
diff --git a/hydro_roll_core/docs/__init__.py b/hydro_roll_core/docs/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/docs/__init__.py
diff --git a/hydro_roll_core/exceptions.py b/hydro_roll_core/exceptions.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/exceptions.py
diff --git a/hydro_roll_core/features/__init__.py b/hydro_roll_core/features/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/features/__init__.py
diff --git a/hydro_roll_core/log.py b/hydro_roll_core/log.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/log.py
diff --git a/hydro_roll_core/performance/__init__.py b/hydro_roll_core/performance/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/performance/__init__.py
diff --git a/hydro_roll_core/py.typed b/hydro_roll_core/py.typed
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/py.typed
diff --git a/hydro_roll_core/rule_package.py b/hydro_roll_core/rule_package.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/rule_package.py
diff --git a/hydro_roll_core/typing.py b/hydro_roll_core/typing.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/typing.py
diff --git a/hydro_roll_core/utils.py b/hydro_roll_core/utils.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/hydro_roll_core/utils.py