faststrapy

faststrapy is a command-line interface (CLI) tool designed to scaffold production-ready FastAPI projects swiftly. Drawing inspiration from the create-next-app, it utilizes Jinja2 templates alongside interactive prompts to streamline project setup.

Users can kickstart a working FastAPI application by answering just a few prompts, or by passing command-line flags to bypass them. The tool automates essential setup tasks such as:

• Managing project settings
• Integrating an optional SQLAlchemy + Alembic database layer
• Enabling structured logging
• Creating a health-check route
• Initializing a Git repository
• Installing dependencies
• Formatting code with Black

Quick Usage Example

To create a new FastAPI project, simply execute:

faststrapy create-app

This command will generate a complete application in a specified directory or the current working directory by default. The auto-generated structure ensures that the necessary files and configurations are in place, allowing immediate development.

Features and Functionalities

• Interactive Setup: Provide project name, framework selection, and Python version.
• Customizable Configuration: Choose whether to use recommended defaults or to tailor every option.
• Post-Generation Steps: Automatically initializes a Git repository and installs dependencies using the uv tool, ensuring a smooth development experience.

Generated Project Structure

A typical run produces a project directory structured as follows:

my-service/
├── app/                        # Project code lives here
│   ├── main.py                 # FastAPI instance + entry point
│   ├── core/                   # Core functionality including configuration
│   ├── middlewares/            # Custom middleware classes
│   ├── utils/                  # Utility functions
│   └── modules/                # Project modules, including routes and models
├── alembic/                    # Data migration scripts (if enabled)
├── .env                        # Environment variables (gitignored)
├── README.md                   # Project documentation
└── pyproject.toml              # Dependency management

Compatibility and Requirements

• Requires Python 3.10 or higher. The generated projects default to Python 3.11, configurable on a per-project basis.
• uv tool for managing project dependencies.
• Git installed for automatic repository initialization.

Conclusion

faststrapy significantly reduces the setup time for FastAPI applications, enabling developers to focus on building features rather than configuring environments. Its modular design and clear project architecture facilitate both new and experienced developers in creating structured and maintainable FastAPI applications.