A CLI tool to quickly scaffold FastAPI projects
Project description
FastAPI Launchpad
A command-line tool to quickly scaffold FastAPI projects with best practices and common patterns.
Features
- Quick project scaffolding with best practices
- Health check endpoint included by default
- Modern project structure following FastAPI recommendations
- Optional database setup: Postgres, MySQL, MongoDB
- Clear
.envand.env.example
Installation
pip install fastapi-launchpad
Usage
- Create a new FastAPI project in a directory named
my_project:
fastapi-launch project my-project
- Create with a specific database:
fastapi-launch project my-project --database postgres
# or --database mysql
# or --database mongodb
- Scaffold into the current directory:
mkdir my-project && cd my-project
fastapi-launch project .
- Show version:
fastapi-launch version
Generated Project Structure
my_project/
├── src/
│ ├── dependencies/
│ ├── models/
│ ├── routers/
│ │ └── health.py
│ ├── schemas/
│ └── main.py
├── tests/
├── .env
├── .env.example
└── requirements.txt
Running the generated app
python -m venv venv
# Windows
.\venv\Scripts\activate
# Unix/Mac
source venv/bin/activate
pip install -r requirements.txt
uvicorn src.main:app --reload
Then visit http://127.0.0.1:8000/docs.
Development
python -m venv .venv
. .venv/Scripts/activate # Windows
# or
source .venv/bin/activate # Unix/Mac
pip install -e .[dev]
pytest -q
License
MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fastapi_launchpad-0.1.0.tar.gz.
File metadata
- Download URL: fastapi_launchpad-0.1.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5806b3ce64b5f43717fff0803b83707647e9246a6f2bb3930c95c12365aba249
|
|
| MD5 |
338d774b05abbba716f7d6e76126cab4
|
|
| BLAKE2b-256 |
d0d4714de6207697bd8966284c28bdf27ee5c28a5784e7e2919bc6636f73a610
|
File details
Details for the file fastapi_launchpad-0.1.0-py3-none-any.whl.
File metadata
- Download URL: fastapi_launchpad-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3e05a5fbde61f3fc5044b831bc8363751140305f2b5c0ed2cfa0772d7712a97
|
|
| MD5 |
c00139b75bc30280a42a3b216e33005a
|
|
| BLAKE2b-256 |
54339f464fcb66cc46f0f10c33de5c0535a64fe38d5cc18b4ab085b59b27f3b4
|