fapier 0.1.0

A command-line tool to scaffold and bootstrap FastAPI projects quickly.

FastAPI Project Generator CLI

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

---

✅ Features

Feature	Description
Generate FastAPI project	Creates a full FastAPI folder structure
Optional Database	Create project with or without SQLAlchemy setup
Auto-creates virtualenv	Creates .venv inside the project
Auto-installs requirements	Installs dependencies based on options
Jinja2 Templates	Clean and flexible template system
Developer friendly	Simple prompts & automatic setup
CLI add commands	Add routes, models, schemas, crud, services

---

📂 Project Output Structure

When DB and routes are enabled:

project_name/
 ├─ app/
 │  ├─ main.py
 │  ├─ core/
 │  │   └─ config.py
 │  ├─ models/
 │  │   └─ user.py
 │  ├─ schemas/
 │  │   └─ user.py
 │  ├─ crud/
 │  │   └─ user.py
 │  ├─ services/
 │  │   └─ example.py
 │  ├─ api/
 │  │   └─ router.py
 │  └─ __init__.py
 ├─ .fastapi                  # internal flag to detect project
 ├─ .env
 ├─ requirements.txt
 └─ .venv/

If database or routes are disabled, the tool skips those folders.

---

🧰 Installation

Clone Repo

git clone https://github.com/aymen-Dahmoun/FApi.git
cd FApi

Install dependencies

pip install -r requirements.txt

Requires Python 3.10+

---

🚀 Usage

Create a project

python cli.py myproject

Answer prompts

Example interaction:

Do you want to use a DB? [y/n]: y
Choose a Database (sqlite/postgres) [sqlite]: sqlite
Do you want to generate routes? [y/n]: y

or simply run

python cli.py myproject --db sqlite --routes

Add new components

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

Auto-detects if you're inside a FastAPI project using .fastapi

---

🏁 Run the project

cd myproject
source .venv/bin/activate   # Linux/Mac
# or .venv\Scripts\activate on Windows

uvicorn app.main:app --reload

---

📌 Roadmap

Feature	Status
Basic FastAPI scaffold	✅ Done
Optional DB	✅ Done
Optional API	✅ Done
fapi add commands	✅ Done
Auto router import	🔜 Planned
Alembic migrations	🔜 Planned
Docker support	🔜 Planned
Publish on PyPI	🎯 Future

---

🤝 Contributing

Pull requests are welcome! 👐

---

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