boilerpy 0.1.0

CLI to quickly scaffold FastAPI and Flask projects with opinionated blueprints.

🚀 BoilerPy

Lightning-fast FastAPI & Flask project scaffolding CLI

Installation • Quick Start • Templates • Documentation

---

🎯 Why BoilerPy?

Stop wasting time setting up the same project structure over and over. BoilerPy generates production-ready FastAPI and Flask projects in seconds with:

• ✅ 5+ Professional Templates - API-only, Auth, SQL, MongoDB, CRM
• ⚡ Lightning Fast - Generate projects in < 5 seconds
• 🎨 Clean Architecture - Industry best practices built-in
• 🔧 Zero Configuration - Works out of the box
• 🐍 Python 3.9+ - Modern Python support

📦 Installation

Using pipx (Recommended)

pipx install boilerpy

Using pip

pip install boilerpy

From source

git clone https://github.com/Faizgeeky/boilerpy.git
cd boilerpy
pip install -e .

🚀 Quick Start

1. List available templates

bpy list

2. Create a new project

bpy init fastapi

3. Follow the interactive prompts

• Select your template (1-5)
• Enter project name
• Done! Your project is ready 🎉

Example

$ bpy init fastapi

============================================================
  Available FASTAPI Templates
============================================================

1. API Only
   Basic FastAPI project with routers and clean architecture

2. Authentication
   FastAPI with JWT authentication, user management

3. SQL (SQLAlchemy + PostgreSQL)
   FastAPI with SQLAlchemy, PostgreSQL, and Alembic migrations

Select template (1-5): 3
Enter project name: my-awesome-api

🚀 Creating SQL project: my-awesome-api
✅ Project created successfully!

📚 Templates

🔷 FastAPI Templates

1. API Only - Clean REST API

Perfect for microservices and REST APIs

app/
├── main.py              # FastAPI application
├── api/v1/
│   ├── router.py        # API router
│   └── endpoints/       # API endpoints
├── core/
│   └── config.py        # Configuration
└── schemas/             # Pydantic models

2. Authentication - JWT Auth System

Production-ready authentication with JWT tokens

app/
├── main.py
├── api/v1/endpoints/
│   ├── auth.py          # Login, register
│   └── users.py         # User management
├── core/
│   ├── security.py      # JWT utilities
│   └── dependencies.py  # Auth dependencies
└── schemas/
    ├── user.py
    └── token.py

3. SQL - SQLAlchemy + PostgreSQL

Full database setup with migrations

app/
├── models/              # SQLAlchemy models
├── crud/                # CRUD operations
├── core/
│   └── database.py      # Database config
├── alembic/             # Migrations
└── docker-compose.yml   # PostgreSQL setup

4. MongoDB - Motor Async Driver

MongoDB integration with async support

app/
├── core/
│   └── database.py      # MongoDB connection
├── models/              # MongoDB models
└── crud/                # Database operations

5. CRM - Complete Application

Full CRM with users, customers, products, orders

app/
├── models/
│   ├── user.py
│   ├── customer.py
│   ├── product.py
│   └── order.py
├── api/v1/endpoints/
│   ├── auth.py
│   ├── customers.py
│   └── orders.py
└── core/
    ├── database.py
    └── security.py

🔶 Flask Templates

Coming soon!

🎨 Features

• 🏗️ Production-Ready - All templates follow industry best practices
• 📁 Clean Structure - Organized, scalable architecture
• 🔐 Security - JWT authentication, password hashing built-in
• 🗄️ Database Ready - SQLAlchemy, PostgreSQL, MongoDB support
• 🐳 Docker Included - docker-compose.yml for databases
• 📝 Type Hints - Full typing support with Pydantic
• 🧪 Testing Ready - Structured for easy testing
• 📖 Documentation - Comprehensive README in each project

📖 Documentation

After Creating a Project

cd my-awesome-api

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Run the application
uvicorn app.main:app --reload

Visit http://localhost:8000/docs for API documentation.

Project Structure

Every generated project includes:

• ✅ requirements.txt - All dependencies
• ✅ .env.example - Environment variables template
• ✅ .gitignore - Git ignore rules
• ✅ README.md - Complete setup guide
• ✅ docker-compose.yml - Database setup (SQL/MongoDB templates)

🛠️ Development

Requirements

• Python 3.9+
• pip or pipx

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Building from Source

git clone https://github.com/Faizgeeky/boilerpy.git
cd boilerpy
python -m build

📝 License

MIT License - see LICENSE for details.

🤝 Support

• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• ⭐ Star us on GitHub: github.com/Faizgeeky/boilerpy

🙏 Acknowledgments

Built with ❤️ by Faiz

Inspired by:

• create-react-app
• vue-cli
• cookiecutter

---

⬆ back to top

Made with ❤️ for the Python community