Skip to content

You can use the mvc-flask extension to turn on MVC pattern in your applications.

License

Notifications You must be signed in to change notification settings

marcuxyz/mvc-flask

Repository files navigation

GitHub code size in bytes GitHub Workflow Status GitHub PyPI - Downloads PyPI - Python Version PyPI

You can use the MVC pattern in your Flask application using this extension.

Installation

Run the follow command to install mvc_flask:

$ pip install mvc_flask

Basic Usage

To start the mvc_flask you need to import and register in your application.

from flask import Flask
from mvc_flask import FlaskMVC

app = Flask(__name__)
FlaskMVC(app)

Or use application factories, e.g:

mvc = FlaskMVC()

def create_app():
  ...
  mvc.init_app(app)

By default the mvc_flask assumes that your application directory will be app and if it doesn't exist, create it! If you can use other directories, you can use the path parameter when the instance of FlaskMVC is initialized. E.g:

mvc = FlaskMVC()

def create_app():
  ...
  mvc.init_app(app, path='src')

Now, you can use src as default directory for prepare your application.

You structure should be look like this:

app
├── __ini__.py
├── controllers
│   └── home_controller.py
├── routes.py
└── views
    ├── index.html

Please visit the documentation to check more details https://marcuxyz.github.io/mvc-flask