optimize: 完善一些信息和格式

Author: PedroGao

app/config/setting.py

@@ -16,5 +16,5 @@
 # plugin config写在字典里面
 PLUGIN_PATH = {
     'oss': {'path': 'app.plugins.oss', 'enable': True, 'upload_folder': 'app/static'},
-    'poem': {'path': 'app.plugins.poem', 'enable': True},
+    'poem': {'path': 'app.plugins.poem', 'enable': True, 'limit': 5},
 }

app/plugins/oss/info.py

@@ -0,0 +1,2 @@
+__version__ = '0.0.1'
+__author__ = 'Lin team'

app/plugins/poem/README.md

@@ -1,6 +1,6 @@
-# 插件demo（古诗展示插件：poem）
+# 插件 demo（古诗展示插件：poem）
 
-> 在大家已经了解了插件机制后，我们按照插件开发规范开发了一个古诗展示插件，在这个demo中，你会学习到一个简单插件的整个开发流程和注意事项
+> 在大家已经了解了插件机制后，我们按照插件开发规范开发了一个古诗展示插件，在这个 demo 中，你会学习到一个简单插件的整个开发流程和注意事项
 
 ### 插件目录结构
 
@@ -17,7 +17,9 @@
 ```
 
 ## 定义路由
+
 首先我们在控制层文件`controller.py`中定义一个红图，并且定义两个视图函数
+
 ```python
 from flask import jsonify
 from lin.redprint import Redprint
@@ -42,7 +44,9 @@ def search():
 ```
 
 ## 定义数据库模型类
+
 `poem`插件的实现的业务需要依托数据库，所以我们下面需要在模型层文件设计一个名为`Poem`的模型类
+
 ```python
 from lin.interface import InfoCrud as Base
 from sqlalchemy import Column, String, Integer
@@ -54,12 +58,14 @@ class Poem(Base):
     author = Column(String(50), default='未名', comment='作者')
     dynasty = Column(String(50), default='位置', comment='朝代')
     content = Column(String(255), nullable=False, comment='内容')
-    
+
     ...
 ```
 
 ## 定义数据校验类
+
 当我们需要校验用户传递过来的参数时，别忘了数据校验层的存在，我们在`forms.py`中定义一个简单的数据校验类`PoemSearchForm`。并在视图函数中调用。
+
 ```python
 from lin.forms import Form
 from wtforms import StringField
@@ -74,13 +80,16 @@ class PoemSearchForm(Form):
 ```
 
 ## 导出文件
-基本业务逻辑已经实现，最关键的一步还要导出文件，也就是在`poem/app/__init__.py`中写入要被Lin的加载器自动加载的红图api和数据模型类
+
+基本业务逻辑已经实现，最关键的一步还要导出文件，也就是在`poem/app/__init__.py`中写入要被 Lin 的加载器自动加载的红图 api 和数据模型类
+
 ```python
 from .controller import api
 from .model import Poem
 ```
 
 ## 用配置开启插件
+
 > 最后，在`app/config/setting.py`中添加如下配置:
 
 ```python
@@ -90,9 +99,11 @@ PLUGIN_PATH = {
     'poem': {'path': 'app.plugins.poem', 'enable': True},
 }
 ```
+
 对于该配置项的含义，已经在[插件使用]一小节详细介绍。
 
-至此，这个简单插件的开发已经完成了。运行项目，我们会发现收据库中会出现我们所创建的poem表。下面请打开fake.py，替换成下面的代码并执行，向表中添加一些初始数据。
+至此，这个简单插件的开发已经完成了。运行项目，我们会发现收据库中会出现我们所创建的 poem 表。下面请打开 fake.py，替换成下面的代码并执行，向表中添加一些初始数据。
+
 ```python
 from app.app import create_app
 from app.plugins.poem.app.model import Poem
@@ -131,64 +142,70 @@ with app.app_context():
         db.session.add(poem4)
 ```
 
-## 用postman调试接口
+## 用 postman 调试接口
 
 ### 获取所有诗词
-URL 
->GET http://localhost:5000/plugin/poem/demo/all
+
+URL
+
+> GET http://localhost:5000/plugin/poem/demo/all
 
 Response 200:
+
 ```json
 [
-    {
-        "author": "李白",
-        "content": "危楼高百尺，手可摘星辰。不敢高声语，恐惊天上人。",
-        "create_time": 1548422493000,
-        "dynasty": "唐代",
-        "id": 1,
-        "title": "夜宿山寺"
-    },
-    {
-        "author": "刘禹锡",
-        "content": "常恨言语浅，不如人意深。今朝两相视，脉脉万重心。",
-        "create_time": 1548422493000,
-        "dynasty": "唐代",
-        "id": 2,
-        "title": "视刀环歌"
-    },
-    {
-        "author": "龚自珍",
-        "content": "浩荡离愁白日斜，吟鞭东指即天涯。落红不是无情物，化作春泥更护花。",
-        "create_time": 1548422493000,
-        "dynasty": "清代",
-        "id": 3,
-        "title": "己亥杂诗 · 其五"
-    },
-    {
-        "author": "温庭筠",
-        "content": "井底点灯深烛伊，共郎长行莫围棋。玲珑骰子安红豆，入骨相思知不知。",
-        "create_time": 1548422493000,
-        "dynasty": "唐代",
-        "id": 4,
-        "title": "杨柳枝"
-    }
+  {
+    "author": "李白",
+    "content": "危楼高百尺，手可摘星辰。不敢高声语，恐惊天上人。",
+    "create_time": 1548422493000,
+    "dynasty": "唐代",
+    "id": 1,
+    "title": "夜宿山寺"
+  },
+  {
+    "author": "刘禹锡",
+    "content": "常恨言语浅，不如人意深。今朝两相视，脉脉万重心。",
+    "create_time": 1548422493000,
+    "dynasty": "唐代",
+    "id": 2,
+    "title": "视刀环歌"
+  },
+  {
+    "author": "龚自珍",
+    "content": "浩荡离愁白日斜，吟鞭东指即天涯。落红不是无情物，化作春泥更护花。",
+    "create_time": 1548422493000,
+    "dynasty": "清代",
+    "id": 3,
+    "title": "己亥杂诗 · 其五"
+  },
+  {
+    "author": "温庭筠",
+    "content": "井底点灯深烛伊，共郎长行莫围棋。玲珑骰子安红豆，入骨相思知不知。",
+    "create_time": 1548422493000,
+    "dynasty": "唐代",
+    "id": 4,
+    "title": "杨柳枝"
+  }
 ]
 ```
 
 ### 按标题搜索诗词
+
 URL
->GET http://localhost:5000/plugin/poem/demo/search?q=<string>
+
+> GET http://localhost:5000/plugin/poem/demo/search?q=<string>
 
 Response 200:
+
 ```json
 [
-    {
-        "author": "龚自珍",
-        "content": "浩荡离愁白日斜，吟鞭东指即天涯。落红不是无情物，化作春泥更护花。",
-        "create_time": 1548422493000,
-        "dynasty": "清代",
-        "id": 3,
-        "title": "己亥杂诗 · 其五"
-    }
+  {
+    "author": "龚自珍",
+    "content": "浩荡离愁白日斜，吟鞭东指即天涯。落红不是无情物，化作春泥更护花。",
+    "create_time": 1548422493000,
+    "dynasty": "清代",
+    "id": 3,
+    "title": "己亥杂诗 · 其五"
+  }
 ]
 ```

fake.py

@@ -4,47 +4,37 @@
 """
 
 from app.app import create_app
-from app.models.book import Book
+from app.plugins.poem.app.model import Poem
 from lin.db import db
-from lin.core import User
 
 app = create_app()
 with app.app_context():
     with db.auto_commit():
-        # 创建一个超级管理员
-        user = User()
-        user.nickname = 'super'
-        user.password = '123456'
-        user.email = '12345678@qq.com'
-        user.super = 2
-        db.session.add(user)
-        # 添加书籍
-        book1 = Book()
-        book1.title = '深入理解计算机系统'
-        book1.author = 'Randal E.Bryant'
-        book1.summary = '''
-        从程序员的视角，看计算机系统！\n
-        本书适用于那些想要写出更快、更可靠程序的程序员。
-        通过掌握程序是如何映射到系统上，以及程序是如何执行的，读者能够更好的理解程序的行为为什么是这样的，以及效率低下是如何造成的。
-        粗略来看，计算机系统包括处理器和存储器硬件、编译器、操作系统和网络互连环境。
-        而通过程序员的视角，读者可以清晰地明白学习计算机系统的内部工作原理会对他们今后作为计算机科学研究者和工程师的工作有进一步的帮助。
-        它还有助于为进一步学习计算机体系结构、操作系统、编译器和网络互连做好准备。\n
-        本书的主要论题包括：数据表示、C程序的机器级表示、处理器结构，程序优化、存储器层次结构、链接、异常控制流、虚拟存储器和存储器管理、系统级I/O、网络编程和并发编程。书中所覆盖的内容主要是这些方面是如何影响应用和系统程序员的。
-        '''
-        book1.image = 'https://img3.doubanio.com/lpic/s1470003.jpg'
-        db.session.add(book1)
+        # 添加诗歌
+        poem1 = Poem()
+        poem1.title = '夜宿山寺'
+        poem1.author = '李白'
+        poem1.dynasty = '唐代'
+        poem1.content = '危楼高百尺，手可摘星辰。不敢高声语，恐惊天上人。'
+        db.session.add(poem1)
 
-        book2 = Book()
-        book2.title = 'C程序设计语言'
-        book2.author = '（美）Brian W. Kernighan'
-        book2.summary = '''
-        在计算机发展的历史上，没有哪一种程序设计语言像C语言这样应用广泛。
-        本书原著即为C语言的设计者之一Dennis M.Ritchie和著名计算机科学家Brian W.Kernighan合著的一本介绍C语言的权威经典著作。
-        我们现在见到的大量论述C语言程序设计的教材和专著均以此书为蓝本。
-        原著第1版中介绍的C语言成为后来广泛使用的C语言版本——标准C的基础。
-        人们熟知的“hello,World"程序就是由本书首次引入的，现在，这一程序已经成为众多程序设计语言入门的第一课。\n
-        原著第2版根据1987年制定的ANSIC标准做了适当的修订．引入了最新的语言形式，并增加了新的示例，通过简洁的描述、典型的示例，作者全面、系统、准确地讲述了C语言的各个特性以及程序设计的基本方法。
-        对于计算机从业人员来说，《C程序设计语言》是一本必读的程序设计语 言方面的参考书。
-        '''
-        book2.image = 'https://img3.doubanio.com/lpic/s1106934.jpg'
-        db.session.add(book2)
+        poem2 = Poem()
+        poem2.title = '视刀环歌'
+        poem2.author = '刘禹锡'
+        poem2.dynasty = '唐代'
+        poem2.content = '常恨言语浅，不如人意深。今朝两相视，脉脉万重心。'
+        db.session.add(poem2)
+
+        poem3 = Poem()
+        poem3.title = '己亥杂诗 · 其五'
+        poem3.author = '龚自珍'
+        poem3.dynasty = '清代'
+        poem3.content = '浩荡离愁白日斜，吟鞭东指即天涯。落红不是无情物，化作春泥更护花。'
+        db.session.add(poem3)
+
+        poem4 = Poem()
+        poem4.title = '杨柳枝'
+        poem4.author = '温庭筠'
+        poem4.dynasty = '唐代'
+        poem4.content = '井底点灯深烛伊，共郎长行莫围棋。玲珑骰子安红豆，入骨相思知不知。'
+        db.session.add(poem4)