Skip to content

krishvsoni/flask-wiz

Repository files navigation

PyPI version
License: MIT

Flask-Wiz

Effortlessly generate Flask project structures with optional frontend and database setup.

Flask-Wiz is a Python package that helps you easily generate a Flask project structure.
It allows you to optionally integrate popular frontend frameworks and choose from multiple database options, keeping the backend powered by Flask.

Key Features

  • Organize a clean Flask backend project quickly.
  • Optionally set up a frontend with frameworks like React.js, Next.js, Vue.js, or Angular.
  • Choose from multiple database options: SQLite, MySQL, PostgreSQL, or MongoDB.
  • Interactive command-line prompts using Inquirer to simplify project setup.
  • Clean separation of backend (server/) and frontend (client/) folders.

Installation

Install Flask-Wiz from PyPI:

pip install flask-wiz

Usage

To generate a new project, simply run:

flask-wiz new

You will be guided through an interactive setup where you can select:

  • Frontend framework (React, Vue, Next.js, Angular, or None)
  • Database (SQLite, MySQL, PostgreSQL, MongoDB)
Enter project name :

Do you need a frontend framework? (Y/N) : 

Select a framework :
    > React.Js
    > Vue.Js
    > Next.Js
    > Angular.Js

Select a database system :
    > pymongo
    > sqlite3
    > pymysql
    > psycopg2-binary

Based on your choices, Flask-Wiz will generate a ready-to-use project structure.

Project Structure

Typical generated structure:

project-name/
|
├── client/           # Frontend app (only if selected)
|   ├── (React/Vue/Angular/Next.js starter)
|
├── server/           # Flask backend
|   ├── app.py
|   ├── requirements.txt
|
└── README.md         # Project README
  • If no frontend is selected, only the server/ folder is created.

Supported Frontend Frameworks

  • None (backend only)
  • React.js
  • Vue.js
  • Angular
  • Next.js

Supported Databases

  • SQLite (default for Flask)
  • MySQL
  • PostgreSQL
  • MongoDB (PyMongo)

Why Use Flask-Wiz?

  • Save time setting up a new Flask project.
  • Choose your preferred frontend integration or focus on backend only.
  • Supports both SQL and NoSQL databases.
  • Easy, interactive setup with minimal manual configuration.

Companies Using Flask-Wiz

  • Sentio: Sentio leverages Flask-Wiz to build API endpoints for their Offchain Analyzer, enabling efficient code analysis. Learn more at sentio-ao.xyz.

Contributing

If you find a bug or have ideas for improvements, feel free to open an issue or submit a pull request. Contributions are always welcome.

Need More Assistance

  • Have a question or need assistance? Raise an issue on our Github Issues

License

Licensed under the MIT License.

About

Flask-Wiz: Simplified Flask Setup Package

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages