项目简介
本项目是基于FastAPI框架的服务构建模板,以ai-service为例,能助力开发者快速搭建FastAPI服务。项目具备配置文件管理、模板一键生成、规范的目录结构,还带有一系列项目相关命令,以及图片去重、Cython加密和Locust性能测试等额外功能。
项目的主要特性和功能
- 配置灵活:借助配置文件以key=value形式提供服务名、版本号、维护者等信息,可灵活定制项目。
- 一键生成模板:于项目目录下运行
make build
命令,可一键生成含服务代码、配置、日志等完整结构的模板。 - 规范的目录结构:生成的项目目录结构清晰,包含项目代码、模型存放、日志、静态文件等目录,方便管理与开发。
- 丰富的项目命令:提供初始化环境、清理环境、代码检查、格式化、构建服务、启动服务、构建Docker镜像、运行Docker容器等命令。
- 附加功能:支持图片去重、Cython加密防止源码泄露和Locust性能测试。
安装使用步骤
前提条件
确保已下载项目源码文件,且安装了Python 3.7+版本。
操作步骤
- 生成模板:在项目目录下运行
make build
命令,一键生成模板。 - 初始化环境:运行
make init
命令,安装开发、测试、生产环境依赖。 - 代码检查与格式化:运行
make lint
进行Python静态代码检查,运行make format
格式化Python代码。 - 构建服务:运行
make build
本地构建服务运行环境。 - 启动服务:运行
make run
本地启动服务。 - 构建并运行Docker容器
- 运行
make build-docker
构建Docker镜像,可在配置文件中配置镜像名、tag等信息。 - 运行
make run-docker
启动Docker容器,可在配置文件中配置容器名、端口映射等信息。
- 运行
- 使用其他功能
- 图片去重:运行
output/lib/image_deduplicate.py
脚本对图片数据去重。 - Cython加密:运行
output/build/lib/cybuild.py
脚本对py文件加密。 - Locust性能测试:在
output/test
目录下运行python locustfile.py
进行性能测试。
- 图片去重:运行
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】