fastapi-scaff 0.8.0

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 jwt\api-key
    • integrated sqlalchemy
    • integrated migration
    • integrated celery
    • integrated docker deployment
    • ...
  • about structure:
    • standard
    • light
    • tiny
    • single
  • more documents: 请点击链接

Project template

• Architecture: ASM

  • A api
  • S services(&schemas)
  • M models(&repositories)

• Flow: main.py(initializer) - (middleware) - api - services(&schemas) - (models&repositories)

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

  └── fastapi-scaff
      ├── app                         (应用)
      │   ├── api                     ├── (api)
      │   │   └── v1                  │   └── (v1)
      │   ├── initializer             ├── (初始化)
      │   │   ├── conf                │   ├── (配置)
      │   │   ├── db                  │   ├── (数据库)
      │   │   ├── log                 │   ├── (日志)
      │   │   └── ...                 │   └── (...)
      │   ├── middleware              ├── (中间件)
      │   ├── migrations              ├── (数据库迁移)
      │   ├── models                  ├── (数据模型)
      │   ├── repositories            ├── (数据仓库)
      │   ├── schemas                 ├── (数据结构)
      │   ├── services                ├── (业务逻辑)
      │   ├── utils                   ├── (utils)
      │   └── main.py                 └── (main.py)
      ├── app_celery                  (应用-celery)
      ├── config                      (配置目录)
      ├── docs                        (文档目录)
      ├── logs                        (日志目录)
      ├── 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)

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 template: fastapi-scaff new <myproj> -t light
  • tiny template: fastapi-scaff new <myproj> -t tiny
  • single template: 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
    • docker-compose.yaml | docker-compose.swarm.yaml[config/nginx.conf]
    • Dockerfile | Dockerfile.slim
  • about docker: click here

License

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

---

☕ 请我喝咖啡

享受开源，也感谢支持。

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