fastapi-scaff 0.10.3

This is a fastapi scaff.

fastapi-scaff

What is this?

• by: axiner
• fastapi-scaff
• This is a fastapi scaff.
  • new project
  • add api
  • about project:
    • auto init project (conf, db, log...)
    • auto register router
    • auto register middleware
    • ...
    • integrated api-key/jwt
    • integrated sqlalchemy
    • integrated migration
    • integrated celery
    • integrated docker deployment
    • ...
  • more documents: 请点击链接

Project template

• Architecture: ASM

  • A api
  • S services
  • M models

• Flow: main.py(core) - (middleware) - api - services - models

• Layout: (The naming has been finalized after multiple revisions, making it concise and easy to understand)

  └── fastapi-scaff
      ├── app                         (应用)
      │   ├── api                     ├── (接口)
      │   │   └── v1                  │   └── (版本1)
      │   ├── core                    ├── (基础)
      │   │   ├── conf                │   ├── (配置)
      │   │   ├── db                  │   ├── (数据库)
      │   │   ├── log                 │   ├── (日志)
      │   │   └── ...                 │   └── (...)
      │   ├── middleware              ├── (中间件)
      │   ├── migrations              ├── (数据库迁移)
      │   ├── models                  ├── (数据模型)
      │   ├── services                ├── (业务逻辑)
      │   ├── utils                   ├── (工具集)
      │   └── main.py                 └── (主入口)
      ├── app_celery                  (应用-异步任务)
      ├── config                      (配置目录)
      ├── docs                        (文档目录)
      ├── tests                       (测试目录)
      ├── .dockerignore
      ├── .gitignore
      ├── .python-version
      ├── build.sh
      ├── docker-compose.yaml
      ├── Dockerfile
      ├── LICENSE
      ├── README.md
      ├── requirements.txt
      └── runserver.py
  

• 【Other】

  • light：Please create and view (with -t light)
  • tiny：Please create and view (with -t tiny)
  • single：Please create and view (with -t single)

• 【Tips】Database, Loguru, Redis, Snowflake, Celery, etc., can all be controlled through parameters to integrate or not, allowing you to flexibly customize the functional modules needed for your project.

Installation

This package can be installed using pip (Python>=3.11):

pip install fastapi-scaff

Scaff usage

• 1）help document
  • fastapi-scaff -h
• 2）new project
  • fastapi-scaff new <myproj>
  • light: fastapi-scaff new <myproj> -t light
  • tiny: fastapi-scaff new <myproj> -t tiny
  • single: fastapi-scaff new <myproj> -t single
• 3）add api
  • cd to project root dir
  • fastapi-scaff add <myapi>
• 4）integrated celery
  • M1。new with --celery: fastapi-scaff new <myproj> --celery
  • M2。add with --celery: fastapi-scaff add <mycelery> --celery

Project run

• 1）cd to project root dir
• 2）modify the configuration, such as for the database
• 3）pip install -r requirements.txt
• 4）python runserver.py
  • more parameters see:
    • about uvicorn: click here
    • about gunicorn: click here
• x）migration
  • eg (Can be executed before runserver):
    • generate: python runmigration.py generate init
    • upgrade: python runmigration.py upgrade
  • about alembic: click here
• x）docker, please see:
  • project files:
    • build.sh (default Dockerfile.slim)
    • Dockerfile | Dockerfile.slim
    • docker-compose.yaml | docker-compose.swarm.yaml[config/nginx.conf]
  • about docker: click here

License

This project is released under the MIT License (MIT). See LICENSE

---

☕ 请我喝咖啡

享受开源，也感谢支持。

如果本项目对您有用，可以考虑 Buy Me a Coffee :)