| Name | msanic JSON |
| Version |
1.0.22
JSON |
| download |
| home_page | None |
| Summary | A web framework who is use sanic + tortoise-orm + redis to quick create http&websocket server. |
| upload_time | 2024-05-10 03:33:31 |
| maintainer | None |
| docs_url | None |
| author | DHDONG |
| requires_python | <3.12,>=3.9 |
| license | MIT |
| keywords |
webserver
sanic
website develop
web framework
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sanic Server
## 设计与依赖说明
1. 服务体系 -- 基于sanic 22.3.x 以上版本的http/websocket服务框架
2. python环境 -- 基于3.9的async/await原生异步模型
3. ORM -- 采用tortoise-orm -- 0.19.1 以上的异步ORM数据模型
4. 数据库连接驱动 -- 建议MySQL/mariaDB采用aiomysql, postgresql采用asyncpg
5. 数据迁移工具 -- 使用aerich作为基本的数据迁移工具
6. 缓存 -- 采用redis作为公有化基础缓存，版本建议 6.x以上
7. 缓存驱动 -- 官方redis驱动支持，采用连接池模式
## 项目说明
参照项目目录
logs -- 运行日志存放目录，按服务区分，服务停止情况下，删除后会自动生成
migrations -- 数据迁移目录，该目录下的数据一般情况不要删除或手动修改，否则会造成数据模型迁移的问题
pyproject.toml -- 当前操作数据的服务
非指定的其余目录皆为实际服务目录，以xi_test目录为例：
-- config -- 该服务的配置存放位置
-- handler -- 常规逻辑或功能处理函数或基类
-- model_db -- 该服务的数据模型存放位置
-- model_rc -- 该服务的缓存模型存放位置，采用内置的可直接继承自RCModel
-- interface -- 该服务的接口逻辑存放位置
-- script -- 该服务的定时脚本、配置脚本、自定义脚本等的存放位置
-- base_api.py -- 该服务的基础接口授权相关内容
-- url_main.py -- 该服务的接口路由入口
-- http_xi_test.py/srv_xi_test.py/ws_xi_test.py -- 服务的启动文件
在项目根目录下 http_XXX.py/srv_XXX.py/ws_XXX.py -- 可运行服务 以http_加服务名
## 添加新的可启动的服务
比如 参照示例，开启一个新的服务 xi_test，切换到相应的python环境，然后运行sanicGuider命令，按照指引生成项目，除项目名必须指定外其余均可默认
## 关于数据迁移
数据迁移工具采用与tortoise-orm配套的aerich迁移工具
1. 在项目model_db下对应的服务目录下定义好数据模型, 以及对应的模型文件
2. 将需要迁移的数据模型所在的文件名添加到配置下的 MODEL_LIST内（默认是main） 不需要迁移的数据模型文件名放到MODEL_EXTRA下（默认是extra）
MODEL_LIST = ['main', 'records']
3. 进入项目根目录，执行 aerich init -t 服务包目录名.config.migrate_db(对应在__init__.py中的名称) 初始化数据库连接 更换服务数据库需要从该步骤重新开始执行，在同一数据库服务下，更新或回退，只参照4、5、6步骤
4. 再执行 aerich init-db 初始化数据库 (首次迁移需要执行这一步，非首次迁移不需要这一步)
5. aerich migrate 生成迁移数据
6. aerich upgrade 发起迁移
7. 如有需求需要回退上一个版本执行 aerich downgrade
## 关于服务部署
这里采用service的方式启停服务，也可以采用sanic官方提供的部署方式或者直接使用supervisor运行
>采用root账户运行：
1. 服务名称是定义的文件名，具体指定的运行账户和虚拟环境路径和启动文件路径需要在文件里进行替换
2. 然后将配置好的服务文件移到 /etc/systemd/system/ 目录下
3. 执行service 服务名 status/start/stop/restart 操作项目的启停和状态查看
>采用一般账户运行(该一般账户必须被允许常驻服务)：
1. 将服务配置】目录下配置文件内的账户指定注释掉，然后替换虚拟环境路径和启动文件路径
2. 在用户目录的.config(隐藏目录, 没有则需要手动创建)下创建systemd/user/目录层级
3. 将修改好的服务配置文件拷贝到账户目录：~/.config/systemd/user/ 目录下
4. 采用 systemctl --user status/start/stop/restart 服务名 操作服务
Raw data
{
"_id": null,
"home_page": null,
"name": "msanic",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "WebServer, Sanic, WebSite Develop, Web Framework",
"author": "DHDONG",
"author_email": "zscych@qq.com",
"download_url": null,
"platform": null,
"description": "# Sanic Server\r\n \r\n## \u8bbe\u8ba1\u4e0e\u4f9d\u8d56\u8bf4\u660e \r\n1. \u670d\u52a1\u4f53\u7cfb -- \u57fa\u4e8esanic 22.3.x \u4ee5\u4e0a\u7248\u672c\u7684http/websocket\u670d\u52a1\u6846\u67b6 \r\n2. python\u73af\u5883 -- \u57fa\u4e8e3.9\u7684async/await\u539f\u751f\u5f02\u6b65\u6a21\u578b \r\n3. ORM -- \u91c7\u7528tortoise-orm -- 0.19.1 \u4ee5\u4e0a\u7684\u5f02\u6b65ORM\u6570\u636e\u6a21\u578b \r\n4. \u6570\u636e\u5e93\u8fde\u63a5\u9a71\u52a8 -- \u5efa\u8baeMySQL/mariaDB\u91c7\u7528aiomysql, postgresql\u91c7\u7528asyncpg \r\n5. \u6570\u636e\u8fc1\u79fb\u5de5\u5177 -- \u4f7f\u7528aerich\u4f5c\u4e3a\u57fa\u672c\u7684\u6570\u636e\u8fc1\u79fb\u5de5\u5177 \r\n6. \u7f13\u5b58 -- \u91c7\u7528redis\u4f5c\u4e3a\u516c\u6709\u5316\u57fa\u7840\u7f13\u5b58\uff0c\u7248\u672c\u5efa\u8bae 6.x\u4ee5\u4e0a \r\n7. \u7f13\u5b58\u9a71\u52a8 -- \u5b98\u65b9redis\u9a71\u52a8\u652f\u6301\uff0c\u91c7\u7528\u8fde\u63a5\u6c60\u6a21\u5f0f \r\n \r\n## \u9879\u76ee\u8bf4\u660e \r\n\u53c2\u7167\u9879\u76ee\u76ee\u5f55\r\nlogs -- \u8fd0\u884c\u65e5\u5fd7\u5b58\u653e\u76ee\u5f55\uff0c\u6309\u670d\u52a1\u533a\u5206\uff0c\u670d\u52a1\u505c\u6b62\u60c5\u51b5\u4e0b\uff0c\u5220\u9664\u540e\u4f1a\u81ea\u52a8\u751f\u6210 \r\nmigrations -- \u6570\u636e\u8fc1\u79fb\u76ee\u5f55\uff0c\u8be5\u76ee\u5f55\u4e0b\u7684\u6570\u636e\u4e00\u822c\u60c5\u51b5\u4e0d\u8981\u5220\u9664\u6216\u624b\u52a8\u4fee\u6539\uff0c\u5426\u5219\u4f1a\u9020\u6210\u6570\u636e\u6a21\u578b\u8fc1\u79fb\u7684\u95ee\u9898\r\npyproject.toml -- \u5f53\u524d\u64cd\u4f5c\u6570\u636e\u7684\u670d\u52a1 \r\n\u975e\u6307\u5b9a\u7684\u5176\u4f59\u76ee\u5f55\u7686\u4e3a\u5b9e\u9645\u670d\u52a1\u76ee\u5f55\uff0c\u4ee5xi_test\u76ee\u5f55\u4e3a\u4f8b\uff1a \r\n -- config -- \u8be5\u670d\u52a1\u7684\u914d\u7f6e\u5b58\u653e\u4f4d\u7f6e \r\n -- handler -- \u5e38\u89c4\u903b\u8f91\u6216\u529f\u80fd\u5904\u7406\u51fd\u6570\u6216\u57fa\u7c7b \r\n -- model_db -- \u8be5\u670d\u52a1\u7684\u6570\u636e\u6a21\u578b\u5b58\u653e\u4f4d\u7f6e \r\n -- model_rc -- \u8be5\u670d\u52a1\u7684\u7f13\u5b58\u6a21\u578b\u5b58\u653e\u4f4d\u7f6e\uff0c\u91c7\u7528\u5185\u7f6e\u7684\u53ef\u76f4\u63a5\u7ee7\u627f\u81eaRCModel \r\n -- interface -- \u8be5\u670d\u52a1\u7684\u63a5\u53e3\u903b\u8f91\u5b58\u653e\u4f4d\u7f6e \r\n -- script -- \u8be5\u670d\u52a1\u7684\u5b9a\u65f6\u811a\u672c\u3001\u914d\u7f6e\u811a\u672c\u3001\u81ea\u5b9a\u4e49\u811a\u672c\u7b49\u7684\u5b58\u653e\u4f4d\u7f6e \r\n -- base_api.py -- \u8be5\u670d\u52a1\u7684\u57fa\u7840\u63a5\u53e3\u6388\u6743\u76f8\u5173\u5185\u5bb9 \r\n -- url_main.py -- \u8be5\u670d\u52a1\u7684\u63a5\u53e3\u8def\u7531\u5165\u53e3 \r\n-- http_xi_test.py/srv_xi_test.py/ws_xi_test.py -- \u670d\u52a1\u7684\u542f\u52a8\u6587\u4ef6 \r\n\u5728\u9879\u76ee\u6839\u76ee\u5f55\u4e0b http_XXX.py/srv_XXX.py/ws_XXX.py -- \u53ef\u8fd0\u884c\u670d\u52a1 \u4ee5http_\u52a0\u670d\u52a1\u540d \r\n\r\n\r\n## \u6dfb\u52a0\u65b0\u7684\u53ef\u542f\u52a8\u7684\u670d\u52a1 \r\n\u6bd4\u5982 \u53c2\u7167\u793a\u4f8b\uff0c\u5f00\u542f\u4e00\u4e2a\u65b0\u7684\u670d\u52a1 xi_test\uff0c\u5207\u6362\u5230\u76f8\u5e94\u7684python\u73af\u5883\uff0c\u7136\u540e\u8fd0\u884csanicGuider\u547d\u4ee4\uff0c\u6309\u7167\u6307\u5f15\u751f\u6210\u9879\u76ee\uff0c\u9664\u9879\u76ee\u540d\u5fc5\u987b\u6307\u5b9a\u5916\u5176\u4f59\u5747\u53ef\u9ed8\u8ba4 \r\n\r\n## \u5173\u4e8e\u6570\u636e\u8fc1\u79fb \r\n\u6570\u636e\u8fc1\u79fb\u5de5\u5177\u91c7\u7528\u4e0etortoise-orm\u914d\u5957\u7684aerich\u8fc1\u79fb\u5de5\u5177 \r\n1. \u5728\u9879\u76eemodel_db\u4e0b\u5bf9\u5e94\u7684\u670d\u52a1\u76ee\u5f55\u4e0b\u5b9a\u4e49\u597d\u6570\u636e\u6a21\u578b, \u4ee5\u53ca\u5bf9\u5e94\u7684\u6a21\u578b\u6587\u4ef6\r\n2. \u5c06\u9700\u8981\u8fc1\u79fb\u7684\u6570\u636e\u6a21\u578b\u6240\u5728\u7684\u6587\u4ef6\u540d\u6dfb\u52a0\u5230\u914d\u7f6e\u4e0b\u7684 MODEL_LIST\u5185\uff08\u9ed8\u8ba4\u662fmain\uff09 \u4e0d\u9700\u8981\u8fc1\u79fb\u7684\u6570\u636e\u6a21\u578b\u6587\u4ef6\u540d\u653e\u5230MODEL_EXTRA\u4e0b\uff08\u9ed8\u8ba4\u662fextra\uff09 \r\nMODEL_LIST = ['main', 'records'] \r\n3. \u8fdb\u5165\u9879\u76ee\u6839\u76ee\u5f55\uff0c\u6267\u884c aerich init -t \u670d\u52a1\u5305\u76ee\u5f55\u540d.config.migrate_db(\u5bf9\u5e94\u5728__init__.py\u4e2d\u7684\u540d\u79f0) \u521d\u59cb\u5316\u6570\u636e\u5e93\u8fde\u63a5 \u66f4\u6362\u670d\u52a1\u6570\u636e\u5e93\u9700\u8981\u4ece\u8be5\u6b65\u9aa4\u91cd\u65b0\u5f00\u59cb\u6267\u884c\uff0c\u5728\u540c\u4e00\u6570\u636e\u5e93\u670d\u52a1\u4e0b\uff0c\u66f4\u65b0\u6216\u56de\u9000\uff0c\u53ea\u53c2\u71674\u30015\u30016\u6b65\u9aa4 \r\n4. \u518d\u6267\u884c aerich init-db \u521d\u59cb\u5316\u6570\u636e\u5e93 (\u9996\u6b21\u8fc1\u79fb\u9700\u8981\u6267\u884c\u8fd9\u4e00\u6b65\uff0c\u975e\u9996\u6b21\u8fc1\u79fb\u4e0d\u9700\u8981\u8fd9\u4e00\u6b65)\r\n5. aerich migrate \u751f\u6210\u8fc1\u79fb\u6570\u636e \r\n6. aerich upgrade \u53d1\u8d77\u8fc1\u79fb \r\n7. \u5982\u6709\u9700\u6c42\u9700\u8981\u56de\u9000\u4e0a\u4e00\u4e2a\u7248\u672c\u6267\u884c aerich downgrade \r\n \r\n## \u5173\u4e8e\u670d\u52a1\u90e8\u7f72 \r\n\u8fd9\u91cc\u91c7\u7528service\u7684\u65b9\u5f0f\u542f\u505c\u670d\u52a1\uff0c\u4e5f\u53ef\u4ee5\u91c7\u7528sanic\u5b98\u65b9\u63d0\u4f9b\u7684\u90e8\u7f72\u65b9\u5f0f\u6216\u8005\u76f4\u63a5\u4f7f\u7528supervisor\u8fd0\u884c\r\n>\u91c7\u7528root\u8d26\u6237\u8fd0\u884c\uff1a \r\n1. \u670d\u52a1\u540d\u79f0\u662f\u5b9a\u4e49\u7684\u6587\u4ef6\u540d\uff0c\u5177\u4f53\u6307\u5b9a\u7684\u8fd0\u884c\u8d26\u6237\u548c\u865a\u62df\u73af\u5883\u8def\u5f84\u548c\u542f\u52a8\u6587\u4ef6\u8def\u5f84\u9700\u8981\u5728\u6587\u4ef6\u91cc\u8fdb\u884c\u66ff\u6362 \r\n2. \u7136\u540e\u5c06\u914d\u7f6e\u597d\u7684\u670d\u52a1\u6587\u4ef6\u79fb\u5230 /etc/systemd/system/ \u76ee\u5f55\u4e0b \r\n3. \u6267\u884cservice \u670d\u52a1\u540d status/start/stop/restart \u64cd\u4f5c\u9879\u76ee\u7684\u542f\u505c\u548c\u72b6\u6001\u67e5\u770b \r\n>\u91c7\u7528\u4e00\u822c\u8d26\u6237\u8fd0\u884c(\u8be5\u4e00\u822c\u8d26\u6237\u5fc5\u987b\u88ab\u5141\u8bb8\u5e38\u9a7b\u670d\u52a1)\uff1a \r\n1. \u5c06\u670d\u52a1\u914d\u7f6e\u3011\u76ee\u5f55\u4e0b\u914d\u7f6e\u6587\u4ef6\u5185\u7684\u8d26\u6237\u6307\u5b9a\u6ce8\u91ca\u6389\uff0c\u7136\u540e\u66ff\u6362\u865a\u62df\u73af\u5883\u8def\u5f84\u548c\u542f\u52a8\u6587\u4ef6\u8def\u5f84 \r\n2. \u5728\u7528\u6237\u76ee\u5f55\u7684.config(\u9690\u85cf\u76ee\u5f55, \u6ca1\u6709\u5219\u9700\u8981\u624b\u52a8\u521b\u5efa)\u4e0b\u521b\u5efasystemd/user/\u76ee\u5f55\u5c42\u7ea7 \r\n3. \u5c06\u4fee\u6539\u597d\u7684\u670d\u52a1\u914d\u7f6e\u6587\u4ef6\u62f7\u8d1d\u5230\u8d26\u6237\u76ee\u5f55\uff1a~/.config/systemd/user/ \u76ee\u5f55\u4e0b \r\n4. \u91c7\u7528 systemctl --user status/start/stop/restart \u670d\u52a1\u540d \u64cd\u4f5c\u670d\u52a1\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A web framework who is use sanic + tortoise-orm + redis to quick create http&websocket server.",
"version": "1.0.22",
"project_urls": null,
"split_keywords": [
"webserver",
" sanic",
" website develop",
" web framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "116aea3eff8de2c37e225b396cb5b158d44d4d34ef97ca2c8860d557a8022627",
"md5": "5d127b096e5a82a646768e7291414e59",
"sha256": "d3a6f20104052a301c7e7d1c2d2579c8a666785a4aefeffc11fb7d5be2a4370a"
},
"downloads": -1,
"filename": "msanic-1.0.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d127b096e5a82a646768e7291414e59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 59279,
"upload_time": "2024-05-10T03:33:31",
"upload_time_iso_8601": "2024-05-10T03:33:31.644084Z",
"url": "https://files.pythonhosted.org/packages/11/6a/ea3eff8de2c37e225b396cb5b158d44d4d34ef97ca2c8860d557a8022627/msanic-1.0.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-10 03:33:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "msanic"
}
