Introduction

Hi FastAPI community! Many times, we need something fast and simple to get started with FastAPI projects. I'm excited to propose Scallpy (https://github.com/jara505/fastapi-scallfolding) as a project scaffolder. Inspired by Vite JS's simplicity, Scallpy generates clean, minimal FastAPI projects instantly, aligning with FastAPI's philosophy of speed and minimalism. This is a community contribution – open to feedback and iterations!

Why Scallpy?

Scallpy addresses common pain points in FastAPI project setup:

• Minimal by Default: Generates a basic FastAPI app with no forced dependencies. Everything is opt-in – nothing is required or imposed.
• Two Templates: "Clean" (single-file app) and "Structured" (modular with API/core/models).
• Interactive CLI: Supports both interactive mode (with prompts for easy setup) and non-interactive mode (accepts parameters for scripting).
• Cross-Platform: Works on Linux, Windows, and macOS.
• Integrated Testing: Includes basic tests to ensure app integrity.
• Poetry Support: Uses Poetry 1.8.3 for dependency management (fixed version for stability and compatibility with FastAPI; Poetry 2.x may introduce breaking changes).

Quick Demo

Install and generate a project in seconds:

pip install scallpy
scallpy create --name my-api --type structured --use-db --use-orm
cd my-api
pip install poetry==1.8.3
poetry install
poetry run uvicorn my-api.main:app --reload

Visit http://127.0.0.1:8000 for your running API!

Benefits for FastAPI Users

• Reduces Boilerplate: No more manual setup of folders, DB connections, or Pydantic models.
• Accelerates Onboarding: New users can start coding immediately without config hassles.
• Community-Driven: Open-source, MIT-licensed, and built by the community.
• Extensible: Easy to add custom templates or features.

Comparison with Alternatives

• Heavy template generators: Often include unnecessary components (like full stacks or complex setups); Scallpy is lightweight and minimal.
• Manual Setup: Time-consuming; Scallpy automates it.

Proposal

If you consider Scallpy could be useful for the community, it would be great if it were included in the official FastAPI documentation as a recommended community tool.

Maintenance: I (or maintainers) can handle updates to keep it aligned with FastAPI.

Current Status

• Version 0.1.3 on PyPI (beta release, feedback welcome).
• Compatible with Python 3.10+ and platforms like Linux, Windows, and macOS.
• Growing community (feedback welcome!).

What do you think? Would love to discuss integration or gather feedback. Thanks for making FastAPI awesome! 🚀