README.rst

qingmi

Qingmi(青咪， 取自 情迷 谐音， 有 亲昵 or 亲密 之意)是一个基于Python3+Flask二次开发的应用层框架， 其内部封装了常用的模块和工具集， 主要用于针对flask web快速高效开发。

安装

pypi安装

pip install qingmi

源码安装

python的版本需求为 Python3+， 推荐 python3.6.7 ：

git clone https://github.com/xiongxianzhu/qingmi.git
cd qingmi
python setup.py install

采用的技术栈

• python3
• flask
• Werkzeug
• mongoengine
• celery
• fabric
• httpie
• Flask-Script
• Flask-WTF
• flask-mongoengine
• Flask-Login
• Flask-RESTful
• Flask-DebugToolbar
• Flask-Celery-Helper
• requests
• Flask-Caching
• Flask-Admin
• Flask-Uploads
• ipython
• Pillow
• click
• wheezy.captcha

功能特性

• 管理后台-admin(flask-admin+sb-admin-2)
• 数据统计-stats
• 短信模块-sms
• 邮件发送-email
• 文件上传-fileupload
• 数据库(mongodb/mysql/postgresql/sqlite3)-db
• 验证码(图片验证码/短信验证码/邮箱验证码)-verify
• 静态文件-static
• IP处理-ip
• 日志-logging
• 认证模块(用户/角色/权限)-auth
• 加密模块-crypto
• http模块-http
• 权限管理-permission
• 配置模块-conf
• 定时任务(任务调度)-task
• 通用API(登录认证/获取token等)-api
• 第三方认证模块(QQ/微信/微博/github等)-oauth
• 第三方支付(支付宝/微信支付/京东支付/翼支付等)
• 部署(faric/rsync)-deploy
• 辅助工具(helper or utils, 加解密[hash/md5]/json/http/ip/日志/正则表达式/时间和日期/...)-utils
• 单元测试-test

目录结构详解

用法

测试

在有setup.py文件目录下， 执行 tox 命令可生成tox.ini文件。

$ cd qingmi
# Install tox
$ sudo pip install tox
# Run the test suites
$ tox

文档

参考项目

• celery
• requests
• django
• flask-login
• flask-admin
• flask-security
• startbootstrap-sb-admin-2
• sb-admin-2-python