FastAPI Project Generator CLI

A CLI tool that scaffolds FastAPI projects with optional database and API structure.

✅ Features

📂 Project Output Structure

When everything is enabled:

project_name/
 ├─ app/
 │  ├─ main.py
 │  ├─ core/
 │  │   ├─ config.py      # Core config with .env loading
 │  │   ├─ database.py    # DB connection (SQLAlchemy Async or MongoDB)
 │  │   └─ security.py    # JWT & Auth logic
 │  ├─ models/
 │  │   └─ user.py
 │  ├─ schemas/
 │  │   └─ user.py
 │  ├─ crud/
 │  │   └─ user.py
 │  ├─ services/
 │  │   ├─ email.py       # Mail service
 │  │   └─ passwordHash.py
 │  ├─ api/
 │  │   ├─ ws/            # WebSocket routes
 │  │   ├─ deps.py        # DI for Auth
 │  │   └─ router.py      # Main router
 │  ├─ tasks/             # Worker logic (Celery/Arq)
 │  └─ __init__.py
 ├─ .fastapi              # internal flag to detect project
 ├─ .env                  # Generated with configured keys
 ├─ requirements.txt
 └─ .venv/

🧰 Installation

Clone Repo

pip install fapier

or

pipx install fapier

Requires Python 3.10+

Usage

Create a project

fapi create myProject

Advanced Options

fapi create myProject --db postgres --is-async --redis --auth jwt --websockets --tasks celery --mail --routes

Add new components

fapi add route product
fapi add model product --schema --crud
fapi add service payment
fapi add schema product
fapi add crud product

🚀 Run the project

Just navigate into your project and run:

fapi run

This automatically detects the virtual environment and runs the project using uvicorn app.main:app --reload.

📌 Roadmap

🤝 Contributing

Pull requests are welcome! 👐

⭐ If you like this tool, give the repo a star!