fastbrick 0.4

A CLI tool for generating FastAPI projects and apps

FastBrick 🚀

A simple CLI tool to generate FastAPI project structures.

Installation

Install FastBrick using:

pip install fastbrick

Run Server

Start the FastAPI server with:

uvicorn main:app --reload

Help Command

To see available options and commands:

fastbrick --help

Usage

Create a New Project Creates a new FastAPI project with a structured layout.

fastbrick create-project my_project

Create a New App Creates a new FastAPI app (router) with database settings.

fastbirck create-app my_app

Project Structure

myproject/
│── main.py          # Entry point for FastAPI app
│── routes.py        # Contains 'custom routes'
│── alembic.ini
│── models.py
│── schemas.py
│── middlewares/
│   ├── middleware.py  # Global middleware logic
│── routers/         # API route modules
│── settings/
│   ├── database.py  # Database configuration
│   ├── routing.py   # Router configurations
│── alembic/

This structure ensures modularity and scalability for your FastAPI project. Adjust the folders and files as needed based on your project requirements.