fastapi-builder 1.2.0

fastapi-builder Project generator and manager for FastAPI

「 FastAPI Builder 」

fastapi 官方网站 ➡

💡 fastapi 项目构建器. 一款帮助你快速构建 fastapi 项目的工具.

• 特性

• TODO

• 快速开始

• 特别感谢

• 许可证

💬 特性

• 参考 Django 化项目基础命令.

• 创建可自定义的 project 项目.

• 创建可定制的 app 应用.

• 为您生成完整的项目结构.

• 对数据库操作进行封装，便于轻松管理.

• 支持数据库包括 Mysql.

• 可选的配置如： Dockerfile、pre-commit.

• 对虚拟环境进行管理.

📁 项目结构

.
├── alembic---------------------项目源码主目录
├── api-------------------------项目源码主目录
│   ├── errors------------------云端数据分析系统
│   └── routes------------------小程序
├── app_user--------------------项目源码主目录
│   ├── api.py------------------小程序
│   ├── model.py----------------小程序
│   └── schema.py---------------小程序
├── core------------------------项目源码主目录
│   ├── .env--------------------小程序
│   ├── config.py---------------小程序
│   ├── events.py---------------小程序
│   └── logger.py---------------小程序
├── db--------------------------项目源码主目录
│   ├── base.py-----------------小程序
│   ├── database.py-------------小程序
│   ├── errors.py---------------小程序
│   └── events.py---------------小程序
├── lib-------------------------项目源码主目录
│   ├── jwt.py------------------小程序
│   └── security.py-------------小程序
├── middleware------------------项目源码主目录
│   └── logger.py---------------小程序
├── models----------------------项目源码主目录
│   ├── base.py-----------------小程序
│   └── mixins.py---------------小程序
├── schemas---------------------项目源码主目录
│   ├── auth.py-----------------小程序
│   ├── base.py-----------------小程序
│   └── jwt.py------------------小程序
├── utils-----------------------项目源码主目录
│   ├── consts.py---------------小程序
│   ├── dbmanager.py------------小程序
│   └── docs.py-----------------小程序
├── .fastapi-builder------------项目源码主目录
└── main.py---------------------项目源码主目录

🎯 TODO

PS: 期待您对本项目做出贡献...

• 持续完善项目框架代码部分

• 持续完善项目框架文档部分

• 优化 requirements.txt

• 提供英文版本

• 提供项目数据库 PostgreSQL 选项

• 提供完整的 run 方法

• 内置 alembic 数据迁移等管理

• 提供对运行环境的检查

• 提供 fastapi venv 命令，创建/开启/关闭虚拟环境

• 针对 Linux 环境提供支持

• 针对 Mac 环境提供支持

• 生成 app 时，自动注入到 project 中（路由管理分配）

🚀 快速开始

=> 依赖：Python 3.6+
=> 详细教程：tutorial

安装 fastapi-builder 项目：

pip install fastapi-builder

查看项目版本：

fastapi --version

项目帮助：

fastapi --help
fastapi startproject --help

创建 fastapi 项目：

fastapi startproject [name]

# or 带有交互选择

fastapi startproject [name] --interactive

创建 fastapi 应用：

fastapi startapp [name]

运行 fastapi 项目：

fastapi run

⚡ 特别感谢

项目配置生成及 questionary 内容基于项目：https://github.com/ycd/manage-fastapi

fastapi 项目基础框架参考：https://github.com/nsidnev/fastapi-realworld-example-app/

🚩 许可证

项目根据麻省理工学院的许可条款授权.