项目的readme模板

项目简介

简述一下项目的功能，主要面向的使用人群。

项目功能

• 用户登录
• 创建用户
• 用户查询

项目结构

TestPlatform
├── applications  # 应用
│  ├── user  # 用户连接的视图
│  ├── tools  # 一些工具文件
│  └── models.py  # model
├── requirement
│  └── requirements.txt
├── .flaskenv  # 项目的配置文件
├── Dockerfile  # docker打包文件
├── docker-compose.yml  # docker启动容器的文件
├── gunicorn.conf.py  # gunicorn的配置文件
├── config.py  # 项目的配置文件
├── run.py  # 开发阶段的项目启动文件
└── start.sh  # shell脚本启动命令

修改项目配置

.flaskenv

# flask配置
FLASK_APP="run.py"
FLASK_ENV="testing"
FLASK_DEBUG=True
FLASK_RUN_HOST="0.0.0.0"
FLASK_RUN_PORT=5001  # 启动端口

本地启动项目

Mac、Linux

创建虚拟环境

python -m venv venv
source ./venv/bin/activate

安装依赖

pip --no-cache-dir install --upgrade pip install
pip --no-cache-dir install -r requirement/requirements.txt
pip --no-cache-dir install gunicorn

配置gunicorn.conf.py

bind = '0.0.0.0:5001'
workers = 2  # 进程数
threads = 2  # 线程数
loglevel = 'info'  # 日志等级

使用gunicorn运行flask项目

gunicorn --preload -c ./gunicorn.conf.py "applications:create_app('testing')"

Windows

创建虚拟环境

python -m venv venv
. ./venv/Scripts/activate

安装依赖

pip --no-cache-dir install --upgrade pip install
pip --no-cache-dir install -r requirement/requirements.txt

运行项目

(venv)$ python run.py

项目部署

通过上传压缩包进行部署

1. 将项目打包成zip压缩包，通过scp上传到服务器， 或者通过ftp三方上传；

   scp -r -P22 E:\testdir.zip root@server_ip:/www/serve
   

2. 在服务器上对压缩包进行解压；

   $ unzip /home/testdir.zip
   

3. 配置虚拟环境

   $ python -m venv venv
   $ source ./venv/bin/activate
   (venv)$ pip --no-cache-dir install -r ./requirement/requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
   (venv)$ pip --no-cache-dir install gunicorn
   

4. 运行

   $ . start.sh
   

通过打包docker镜像进行部署

1. 打包镜像

   $ docker build -t testdir:v1.0 .
   

2. 使用镜像

   $ docker run -d --name=test -p 5001:5001 testdir:v1.0