Metadata-Version: 2.4
Name: fastapi-launch
Version: 1.0.0
Summary: CLI tool to quickly scaffold a FastAPI project
Author-email: Robert Harris <robert.harris@devere-group.com>
License: MIT License
        
        Copyright (c) 2025 Your Name
        
        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.
        
Project-URL: Homepage, https://github.com/dvrob/fastapi-launch
Project-URL: Repository, https://github.com/dvrob/fastapi-launch
Project-URL: Issues, https://github.com/dvrob/fastapi-launch/issues
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.3.0
Dynamic: license-file

# 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

```bash
pip install fastapi-launch
```

## Usage

### Initialize a new project

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

   ```bash
   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](LICENSE) file for details.

## Contributing

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