Flask Builder

Flask Builder is a Visual Studio Code extension designed to quickly scaffold a Flask application with the necessary modules, Docker support, and integration and unit tests.

Screenshots

Features

• Flask App Structure: Automatically creates a Flask application structure with config, db, modules, and tests directories.
• Main Module: Includes a main module inside the modules directory with a sample route, controller, and integration and unit tests.
• Create Module: Quickly create a new module with a route, controller, and tests.
• Docker Support: Generates a Dockerfile and docker-compose.yml for easy Docker setup.
• .env File: Adds a default .env file for environment variables.
• Testing: Includes Pytest configuration and example tests.
• Swagger: Implemented Swagger for API documentation. It can be accessed at http://localhost:5000/apidocs.

Usage

1. Create Flask App:
   • Right-click on a folder in the Explorer view.
   • Select Create Flask App.

Example

The generated structure includes:

app/
├── config/
│   ├── __init__.py
│   └── config.py
├── db/
│   ├── __init__.py
│   └── db.py
├── modules/
│   └── main/
│       ├── __init__.py
│       ├── routes.py
│       ├── controller.py
│       └── main_tests_.py
├── tests/
│   ├── __init__.py
│   └── conftest.py
|   └── test_main.py
├── app.py
├── initialize_functions.py
├── run.py
└── wsgi.py
Dockerfile
docker-compose.yml
.env
.gitignore
requirements.txt

Requirements

• Visual Studio Code v1.91.0 or higher

Installation

1. Download and install the extension from the VSCode Marketplace.
2. Reload VSCode.

Release Notes

1.1.5

• Implemented swagger for API documentation.
• Added .gitignore file.

1.1.4

• Added integration test for creating a Flask module.
• Added auto blueprints registration for new modules.

Support the Project

If you find this extension useful, consider supporting its development by buying me a coffee.

Enjoy using Flask Builder! If you have any issues or suggestions, please open an issue on the GitHub repository.