Metadata-Version: 2.4
Name: fastapi-launchpad
Version: 0.1.0
Summary: A CLI tool to quickly scaffold FastAPI projects
Project-URL: Homepage, https://github.com/talhajamil05/fastapi-launchpad
Project-URL: Documentation, https://github.com/talhajamil05/fastapi-launchpad#readme
Project-URL: Issues, https://github.com/talhajamil05/fastapi-launchpad/issues
Project-URL: Source, https://github.com/talhajamil05/fastapi-launchpad
Author-email: Talha Jamil <t.jamil05@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Talha Jamil
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: boilerplate,cli,fastapi,scaffold,starter,template
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: fastapi>=0.100.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.9.0
Requires-Dist: uvicorn>=0.22.0
Provides-Extra: dev
Requires-Dist: mypy>=1.5.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.3.0; extra == 'dev'
Requires-Dist: typer[all]>=0.9.0; extra == 'dev'
Description-Content-Type: text/markdown

# 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 `.env` and `.env.example`

## Installation

```bash
pip install fastapi-launchpad
```

## Usage

- Create a new FastAPI project in a directory named `my_project`:

```bash
fastapi-launch project my-project
```

- Create with a specific database:

```bash
fastapi-launch project my-project --database postgres
# or --database mysql
# or --database mongodb
```

- Scaffold into the current directory:

```bash
mkdir my-project && cd my-project
fastapi-launch project .
```

- Show version:

```bash
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

```bash
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

```bash
python -m venv .venv
. .venv/Scripts/activate  # Windows
# or
source .venv/bin/activate # Unix/Mac

pip install -e .[dev]
pytest -q
```

## License

MIT License