# python-flask

**Repository Path**: a35809453/python-flask

## Basic Information

- **Project Name**: python-flask
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-09
- **Last Updated**: 2024-10-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Python - Flask项目
后端基于 python [Flask](https://flask.palletsprojects.com/zh-cn/main/) 框架开发  
## 项目结构
|-- LogHandler.py\
|-- config.py\
|-- requirements.txt\
|-- run.py  --> *'项目启动入口'*\
|-- shutdown.sh  --> *'结束项目后台进程脚本'*\
|-- start.sh  --> *'后台启动flask项目脚本，支持环境配置参数 local(默认) pro dev test'*\
|-- app\
  |-- __init__.py  --> *'flask初始化配置'*\
  |-- application  --> *'接口逻辑层'*\
  |  |-- __init__.py\
  |  |-- bugly.py\
  |  |-- settings  --> *'逻辑层使用工具'*\
  |    |-- local_config.py  --> *'项目启动环境配置'*\
  |-- utils\
  |  |-- feishu_tool.py \
  |-- web  --> *'视图层，对外暴露接口，不要在这里写逻辑'*\
  |  |-- __init__.py  --> *'flask统一接口蓝图，web目录下每添加一个文件，都需要在这里标记'*\
  |  |-- bugly_stat.py

## 项目说明
### conda虚拟环境
python项目使用conda创建虚拟环境运行，start.sh脚本中支持指定conda env，注意环境切换！！

### docker部署
**依赖image**\
`docker pull python:3.8`\
**build image** \
FLASK_ENV可选参数：\
local(默认) 本地环境\
pro 正式环境\
dev 开发环境\
test 测试环境\
`docker build -t python-flask .`\
**run** \
`docker run  --name flask -p 80:5001 -e FLASK_ENV=pro python-flask`\

### 脚本命令
**项目启动**\
`sh start.sh `\
可选参数：\
local(默认) 本地环境\
pro 正式环境\
dev 开发环境\
test 测试环境\
**项目结束**\
`sh shutdown.sh`

### flask全局变量
在所有文件中引用flask **current_app** 可全局获取Flask对象，可获取全局配置，如静态变量、logger等；\
在所有文件中引用flask **g**可全局获取添加的变量


### 目录的生成
`npm install mddir --save`\
`cd python-flask/node_modules/mddir/src`\
`node mddir ../../../`

### 依赖包requirements.txt的生成与安装
`pigar generate`\
`pip install -r requriements.txt`