diff --git a/doc/flask/README.md b/doc/flask/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cda200dbc36b6cf53cbf5385245bba09aafbac06 --- /dev/null +++ b/doc/flask/README.md @@ -0,0 +1,3 @@ +## 更新日志 :id=log + +> 当前版本：`Flask 1.00.release`，更新于：`2021-06-03`，查看 [在线演示](http://flask.pearadmin.com/)。 diff --git a/doc/flask/_sidebar.md b/doc/flask/_sidebar.md new file mode 100644 index 0000000000000000000000000000000000000000..5be00acd9c6ff6afd192449bdb0250beec828ad3 --- /dev/null +++ b/doc/flask/_sidebar.md @@ -0,0 +1,12 @@ +* [开始使用](start/?id=install) +* [下载安装](install/) +* [权限管理](admin/auth) +* [项目结构](admin/list) +* [公共函数](admin/base) +* [常见问题](help/) + +
+ + + +
\ No newline at end of file diff --git a/doc/flask/admin/auth.md b/doc/flask/admin/auth.md new file mode 100644 index 0000000000000000000000000000000000000000..62decc34c86b44c6b623fbbd55f2c7fc5dbdace1 --- /dev/null +++ b/doc/flask/admin/auth.md @@ -0,0 +1,17 @@ +### 权限管理 :id=authorize + +使用装饰器 @authorize时需要注意，该装饰器需要写在 @app.route 之后 + +```python +@authorize(power: str, log: bool) +``` + +第一个参数为权限 code + +第二个参数为是否生成日志 + +```python +# 例如 +@authorize("admin:power:remove", log=True) +``` + diff --git a/doc/flask/admin/base.md b/doc/flask/admin/base.md new file mode 100644 index 0000000000000000000000000000000000000000..19c9d50f54cc90b9e46cb712e8e081ad9d87860b --- /dev/null +++ b/doc/flask/admin/base.md @@ -0,0 +1,39 @@ +## model序列化 :id=Schema + +- sqlalchemy查询的model对象转dict + + +``` + model_to_dicts(Schema, model) +``` + +Schema 是 序列化类,我把他放在了models文件里，觉得没有必要见一个文件夹叫Schema，也方便看着模型写序列化类 + +```python +# 例如 +class DeptSchema(ma.Schema): # 序列化类 + deptId = fields.Integer(attribute="id") + parentId = fields.Integer(attribute="parent_id") + deptName = fields.Str(attribute="dept_name") + leader = fields.Str() + phone = fields.Str() + email = fields.Str() + address = fields.Str() + status = fields.Str() + sort = fields.Str() +``` + +>这一部分有问题的话请看marshmallow文档 + +model写的是查询后的对象 + +```python +dept = Dept.query.order_by(Dept.sort).all() +``` + +进行序列化 + +``` +res = model_to_dicts(Schema=DeptSchema, model=dept) +``` + diff --git a/doc/flask/admin/list.md b/doc/flask/admin/list.md new file mode 100644 index 0000000000000000000000000000000000000000..f55596165c414be15e7c92302a29e8160197344d --- /dev/null +++ b/doc/flask/admin/list.md @@ -0,0 +1,9 @@ +## 应用结构 :id=config +```应用结构 + +``` + +## 资源结构 :id=static +```资源结构 + +``` \ No newline at end of file diff --git a/doc/flask/favicon.ico b/doc/flask/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..fb28ddf4380c864c911d8ee31d185d8c95c0fdb6 Binary files /dev/null and b/doc/flask/favicon.ico differ diff --git a/doc/flask/help/README.md b/doc/flask/help/README.md new file mode 100644 index 0000000000000000000000000000000000000000..fcef5055d2733e45f14f2f500dd057036e86b114 --- /dev/null +++ b/doc/flask/help/README.md @@ -0,0 +1 @@ +暂无问题 \ No newline at end of file diff --git a/doc/flask/image/1.png b/doc/flask/image/1.png new file mode 100644 index 0000000000000000000000000000000000000000..775c51e4f9e3d562cb28265d4d9659eaf6b73482 Binary files /dev/null and b/doc/flask/image/1.png differ diff --git "a/doc/flask/image/\350\214\266\347\214\253\344\272\221.png" "b/doc/flask/image/\350\214\266\347\214\253\344\272\221.png" new file mode 100644 index 0000000000000000000000000000000000000000..1ab92d8cf4c107159ffe1ef53953c88c3df7362a Binary files /dev/null and "b/doc/flask/image/\350\214\266\347\214\253\344\272\221.png" differ diff --git a/doc/flask/img/curd.png b/doc/flask/img/curd.png new file mode 100644 index 0000000000000000000000000000000000000000..290b6d54fb534677b6a2d58c5c67f6da02013214 Binary files /dev/null and b/doc/flask/img/curd.png differ diff --git a/doc/flask/img/hello.png b/doc/flask/img/hello.png new file mode 100644 index 0000000000000000000000000000000000000000..82e07c31a63b19dae1e83568bc86b6380685aecd Binary files /dev/null and b/doc/flask/img/hello.png differ diff --git a/doc/flask/index.html b/doc/flask/index.html new file mode 100644 index 0000000000000000000000000000000000000000..db99905f334b28bb88d146dfdca1bdc1d218bdbe --- /dev/null +++ b/doc/flask/index.html @@ -0,0 +1,21 @@ + + + + + + + + + Pear Admin Flask 开发文档 + + + + + +
加载中..
+ + + + + + \ No newline at end of file diff --git a/doc/flask/install/README.md b/doc/flask/install/README.md new file mode 100644 index 0000000000000000000000000000000000000000..39f9686acb2e042da784b75a0faed3660053322c --- /dev/null +++ b/doc/flask/install/README.md @@ -0,0 +1,45 @@ +### 环境要求 :id=install +- Python >= 3.6 +- Mysql >= 5.7.0 + +### 安装配置 +```shell +git clone https://gitee.com/pear-admin/pear-admin-flask.git + +# 进 入 项 目 主 目 录 + +# 创 建 虚 拟 环 境 在 当 前 目 录 的 venv 文 件 夹 +python -m venv venv + +# 激 活 虚 拟环 境 +venv\Scripts\activate + +# 安 装 +pip install -r requirement.txt + +# 配 置 数 据 库 +applications\config\database.py + +# 初始化数据库 +python dev/initDb.py + +``` + + + +### 设置 + +```.flaskenv +.flaskenv文件 +FLASK_APP=main.py +FLASK_ENV=development +FLASK_DEBUG=1 +FLASK_RUN_HOST = 127.0.0.1 +FLASK_RUN_PORT = 5000 +``` + + + +- 如果局域网访问，将FLASK_RUN_HOST设置为 0.0.0.0 + + \ No newline at end of file diff --git a/doc/flask/start/README.md b/doc/flask/start/README.md new file mode 100644 index 0000000000000000000000000000000000000000..29f4ad10c9c3fd856eb265c72ad21464d3e1fea7 --- /dev/null +++ b/doc/flask/start/README.md @@ -0,0 +1,28 @@ +## 项目介绍 :id=start + +Pear Admin Flask 基于 Flask 的后台管理系统，拥抱应用广泛的python语言，通过使用本系统，即可快速构建你的功能业务 + +项目旨在为python开发者提供一个后台管理系统的模板，成为您构建信息管理系统，物联网后台....等等应用时灵活，简单的工具 + +各位Python爱好者多多指教 + +> 当前版本：`Release v1.00`，查看 [在线演示](http://flask.pearadmin.com/)。 + +![开始使用](README_files/1.jpg) + + +## 下载使用 :id=download + + +#### 1. 官网地址 + +官网提供稳定版本的 Release 发行版本 [前往](http://www.pearadmin.com) + +![官方网址](README_files/1.png) + +#### 2. 源码仓库 + +如果你需要最新代码，请前往 Gitee 仓库 [前往](https://gitee.com/pear-admin/pear-admin-flask) + +![源码仓库](README_files/2.jpg) + diff --git a/doc/flask/start/README_files/1.jpg b/doc/flask/start/README_files/1.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d12b6fb1ac8baab66a35ad90079c56fd72c1d86c Binary files /dev/null and b/doc/flask/start/README_files/1.jpg differ diff --git a/doc/flask/start/README_files/1.png b/doc/flask/start/README_files/1.png new file mode 100644 index 0000000000000000000000000000000000000000..59682f2c3625a3cce66b3018dde5c01f00ecad52 Binary files /dev/null and b/doc/flask/start/README_files/1.png differ diff --git a/doc/flask/start/README_files/2.jpg b/doc/flask/start/README_files/2.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6d06c37f0988fd6b19730e271e6e6d3d97b95466 Binary files /dev/null and b/doc/flask/start/README_files/2.jpg differ diff --git a/doc/flask/start/README_files/2.png b/doc/flask/start/README_files/2.png new file mode 100644 index 0000000000000000000000000000000000000000..d3184c9a22f2088ed04409895a7f627ccbc1066b Binary files /dev/null and b/doc/flask/start/README_files/2.png differ diff --git a/doc/index.html b/doc/index.html index 0189ed940b9c80985489caf73197d7e80c704648..868bae30cb46ca2e0bae9181bc215f767602f091 100644 --- a/doc/index.html +++ b/doc/index.html @@ -359,12 +359,13 @@ .ew-dark .e-header .e-nav a { color: #CCCCCC; } - .banner{ - z-index: 1000000000; - bottom: 10px; - right: 10px; - position: absolute; - } + + .banner { + z-index: 1000000000; + bottom: 10px; + right: 10px; + position: absolute; + } @@ -389,6 +390,9 @@
  • Ant 版本
    • +
  • + Flask 版本 +
    • @@ -399,11 +403,11 @@
    - + - +