Skip to main content

CLI tool to quickly scaffold a FastAPI project

Project description

FastAPI Launch

A CLI tool to quickly scaffold a FastAPI project with authentication, database migrations, and modern development setup.

Features

  • 🚀 Quick Setup: Initialize a complete FastAPI project in seconds
  • 🔐 Authentication: Built-in JWT authentication system
  • 🗄️ Database: Async MySQL/PostgreSQL/SQLite support with Alembic migrations
  • 🛠️ Modern Tooling: Pre-configured with Ruff, Pyright, and UV
  • 📚 Documentation: Auto-generated API docs with Swagger/OpenAPI
  • 🔒 Security: Rate limiting, CORS, and security best practices

Installation

pip install fastapi-launch

Usage

Initialize a new project

fastapi-launch init --name myproject

This creates a new FastAPI project in the myproject directory with:

  • Complete FastAPI application structure
  • Authentication system with JWT
  • Database models and migrations
  • API documentation
  • Development tools configuration

Options

  • --name: Project folder name (default: fastapi_app)
  • --path: Path where to create the project (default: current directory)

Project Structure

The generated project includes:

myproject/
├── app/
│   ├── main.py              # FastAPI application
│   ├── db/                   # Database configuration
│   ├── lib/                  # Utilities and config
│   └── routers/              # API routes
│       ├── auth/             # Authentication endpoints
│       └── user/             # User management
├── migrations/               # Database migrations
├── pyproject.toml           # Project dependencies
├── run.py                   # Development server
└── README.md                # Project documentation

Next Steps

After creating your project, follow the setup instructions in the generated project's README.md:

  1. Navigate to your project:

    cd myproject
    
  2. Follow the README.md instructions for:

    • Installing dependencies
    • Setting up environment variables
    • Creating your database
    • Running migrations
    • Starting the development server

The generated project includes a complete README.md with detailed setup instructions specific to your FastAPI project.

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_launch-1.0.0-py3-none-any.whl (80.6 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_launch-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: fastapi_launch-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 80.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for fastapi_launch-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a52d615a508db7803f9704daf59792a3b041a3f3554b0b293d7c4eefc3238a1f
MD5 671044e1d458e10f83bbadd2a75b8394
BLAKE2b-256 e4e52cae473bc6aa4effde4c9fceccdeca16efbb11391ef98643676bf736e0cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page