DushuoServer 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,123 @@
1
+ Metadata-Version: 2.1
2
+ Name: DushuoServer
3
+ Version: 0.1.0
4
+ Summary: 度朔系统之服务端,提供度朔中心调度功能
5
+ Author-Email: Eilles <W-YI_DoctorYI@outlook.com>
6
+ Requires-Python: <4.0,>=3.10
7
+ Requires-Dist: fastapi<1.0.0,>=0.162.0
8
+ Requires-Dist: qrcode[pil]<9.0.0,>=8.2
9
+ Requires-Dist: uvicorn[standard]<1.0.0,>=0.54.0
10
+ Requires-Dist: trimlog<2.0.0,>=1.1.3
11
+ Requires-Dist: tomli>=2.0.0; python_version < "3.11"
12
+ Requires-Dist: tomli-w<2.0.0,>=1.2.0
13
+ Requires-Dist: pydantic<3.0.0,>=2.14.3
14
+ Requires-Dist: cryptography<47.0.0,>=44.0.0
15
+ Provides-Extra: dev
16
+ Requires-Dist: pytest>=8.0; extra == "dev"
17
+ Requires-Dist: httpx>=0.27; extra == "dev"
18
+ Description-Content-Type: text/markdown
19
+
20
+ # 度朔·服务端
21
+
22
+ 度朔山、度灵欢,引入鬼门关。
23
+
24
+ > _上古之人,有神荼、鬱壘者,昆弟二人,性能執鬼,居東海度朔山上,立桃樹下,簡閱百鬼。_
25
+ > —— 汉·王充《論衡·亂龍》
26
+
27
+ **度朔**是一个通过监控数字活动来进行生死判断并执行亡语命令的系统。
28
+
29
+ > 若我在某一刻停止了一切数字生活,这样的情况达到一定的时间,则我便已死亡。若我死亡,我的亡语将被执行。
30
+
31
+ 本仓库为度朔系统的**服务端**,提供纯后端 HTTP 接口。
32
+
33
+ 若需使用,应搭配度朔系统的[**客户端**](../dushuoclient)。
34
+
35
+ ## 功能
36
+
37
+ 客户端监测用户的数字活动数据,将数据上传至服务端,服务端收到任意客户端的数字活动之后,会刷新一个死亡判定倒计时。
38
+
39
+ 当倒计时结束,服务端将执行客户端上传的命令作为最终任务。
40
+
41
+ ## 启动
42
+
43
+ ### 安装依赖
44
+
45
+ 1. 使用 uv:
46
+
47
+ ```bash
48
+ uv sync # 可通过 `--extra dev` 参数安装开发测试依赖
49
+ ```
50
+
51
+ ### 启动服务
52
+
53
+ 1. 使用 uv:
54
+
55
+ ```bash
56
+ uv run dushuoserver
57
+ ```
58
+
59
+ 2. 纯 Python:
60
+
61
+ ```bash
62
+ python -m dushuoserver
63
+ ```
64
+
65
+ 3. 也可以直接使用 Uvicorn:
66
+
67
+ ```bash
68
+ uvicorn dushuoserver.app:app --app-dir src --host 0.0.0.0 --port 18470
69
+ ```
70
+
71
+ 4. 也可以通过 pip 安装本项目,并使用命令行入口启动:
72
+
73
+ ```bash
74
+ pip install .
75
+ dushuoserver --help
76
+ ```
77
+
78
+ ### 查看参数
79
+
80
+ 在启动指令后增加 `--help` 参数查看参数说明,例如:
81
+
82
+ ```bash
83
+ dushuoserver --help
84
+ ```
85
+
86
+ ## 配置
87
+
88
+ 服务端启动时,读取配置参数的优先级为:**默认配置 < 配置文件 < 命令行参数 < 服务端现有数据库**
89
+
90
+ 其中,数据库仅会存储运行时参数。以下是默认配置文件:
91
+
92
+ ```toml
93
+ host_address = "0.0.0.0" # 服务端地址
94
+ host_port = 18470 # 服务端端口
95
+ log_level = "info" # 全局日志等级,可以是 DEBUG, INFO, WARNING, ERROR, CRITICAL
96
+ db_path = "dushuodb.sqlite3" # 数据库路径
97
+
98
+ [uvicron]
99
+ workers = 1 # uvicorn 工作进程数
100
+ hot_reload = false # 是否开启热重载
101
+ access_log = true # 是否开启访问日志
102
+
103
+ [runtime] # 运行时参数可在服务端启动后更改,从配置文件读取之后,也会在数据库中重新读取一遍,优先级为 数据库 > 命令行传参 > 配置文件 > 默认参数
104
+ activity_cache_duration = 86400 # 客户端活动消息的缓存时长(秒)
105
+ death_countdown = 86400 # 死亡判定倒计时(秒)
106
+ execution_task = "" # 最终任务执行命令
107
+ message_cache_duration = 3600 # 短报文缓存时长(秒)
108
+ pairing_window_time = 300 # 配对窗口时长(秒)
109
+ signature_time_tolerance = 300 # 签名时间容差(秒)
110
+
111
+ ```
112
+
113
+ 启动服务时,可以在命令行通过 `--config` 参数指定配置文件路径,例如:
114
+
115
+ ```bash
116
+ dushuoserver --config /path/to/config.toml
117
+ ```
118
+
119
+ 执行服务端程序时,可通过 `--help` 查看参数说明。
120
+
121
+ ## API
122
+
123
+ 详见 [接口文档](./docs/API-Reference.md) 。除 `/health` 与配对相关接口外,所有业务接口均需要先在配对窗口内完成配对,之后以客户端私钥对请求签名(签名置于 `X-Client-Id`、`X-Timestamp`、`X-Signature` 三个请求头中),由服务端以配对时登记的公钥校验。
@@ -0,0 +1,104 @@
1
+ # 度朔·服务端
2
+
3
+ 度朔山、度灵欢,引入鬼门关。
4
+
5
+ > _上古之人,有神荼、鬱壘者,昆弟二人,性能執鬼,居東海度朔山上,立桃樹下,簡閱百鬼。_
6
+ > —— 汉·王充《論衡·亂龍》
7
+
8
+ **度朔**是一个通过监控数字活动来进行生死判断并执行亡语命令的系统。
9
+
10
+ > 若我在某一刻停止了一切数字生活,这样的情况达到一定的时间,则我便已死亡。若我死亡,我的亡语将被执行。
11
+
12
+ 本仓库为度朔系统的**服务端**,提供纯后端 HTTP 接口。
13
+
14
+ 若需使用,应搭配度朔系统的[**客户端**](../dushuoclient)。
15
+
16
+ ## 功能
17
+
18
+ 客户端监测用户的数字活动数据,将数据上传至服务端,服务端收到任意客户端的数字活动之后,会刷新一个死亡判定倒计时。
19
+
20
+ 当倒计时结束,服务端将执行客户端上传的命令作为最终任务。
21
+
22
+ ## 启动
23
+
24
+ ### 安装依赖
25
+
26
+ 1. 使用 uv:
27
+
28
+ ```bash
29
+ uv sync # 可通过 `--extra dev` 参数安装开发测试依赖
30
+ ```
31
+
32
+ ### 启动服务
33
+
34
+ 1. 使用 uv:
35
+
36
+ ```bash
37
+ uv run dushuoserver
38
+ ```
39
+
40
+ 2. 纯 Python:
41
+
42
+ ```bash
43
+ python -m dushuoserver
44
+ ```
45
+
46
+ 3. 也可以直接使用 Uvicorn:
47
+
48
+ ```bash
49
+ uvicorn dushuoserver.app:app --app-dir src --host 0.0.0.0 --port 18470
50
+ ```
51
+
52
+ 4. 也可以通过 pip 安装本项目,并使用命令行入口启动:
53
+
54
+ ```bash
55
+ pip install .
56
+ dushuoserver --help
57
+ ```
58
+
59
+ ### 查看参数
60
+
61
+ 在启动指令后增加 `--help` 参数查看参数说明,例如:
62
+
63
+ ```bash
64
+ dushuoserver --help
65
+ ```
66
+
67
+ ## 配置
68
+
69
+ 服务端启动时,读取配置参数的优先级为:**默认配置 < 配置文件 < 命令行参数 < 服务端现有数据库**
70
+
71
+ 其中,数据库仅会存储运行时参数。以下是默认配置文件:
72
+
73
+ ```toml
74
+ host_address = "0.0.0.0" # 服务端地址
75
+ host_port = 18470 # 服务端端口
76
+ log_level = "info" # 全局日志等级,可以是 DEBUG, INFO, WARNING, ERROR, CRITICAL
77
+ db_path = "dushuodb.sqlite3" # 数据库路径
78
+
79
+ [uvicron]
80
+ workers = 1 # uvicorn 工作进程数
81
+ hot_reload = false # 是否开启热重载
82
+ access_log = true # 是否开启访问日志
83
+
84
+ [runtime] # 运行时参数可在服务端启动后更改,从配置文件读取之后,也会在数据库中重新读取一遍,优先级为 数据库 > 命令行传参 > 配置文件 > 默认参数
85
+ activity_cache_duration = 86400 # 客户端活动消息的缓存时长(秒)
86
+ death_countdown = 86400 # 死亡判定倒计时(秒)
87
+ execution_task = "" # 最终任务执行命令
88
+ message_cache_duration = 3600 # 短报文缓存时长(秒)
89
+ pairing_window_time = 300 # 配对窗口时长(秒)
90
+ signature_time_tolerance = 300 # 签名时间容差(秒)
91
+
92
+ ```
93
+
94
+ 启动服务时,可以在命令行通过 `--config` 参数指定配置文件路径,例如:
95
+
96
+ ```bash
97
+ dushuoserver --config /path/to/config.toml
98
+ ```
99
+
100
+ 执行服务端程序时,可通过 `--help` 查看参数说明。
101
+
102
+ ## API
103
+
104
+ 详见 [接口文档](./docs/API-Reference.md) 。除 `/health` 与配对相关接口外,所有业务接口均需要先在配对窗口内完成配对,之后以客户端私钥对请求签名(签名置于 `X-Client-Id`、`X-Timestamp`、`X-Signature` 三个请求头中),由服务端以配对时登记的公钥校验。