Flask-Plugin
An extension to add support of Plugin in Flask.
Features:
- Define plugin routes in the same way as Application, Blueprint, while providing all the Flask features (Template rendering, url_for, message flashing, signals, etc.)
- Each plugin can be started, stopped, reloaded while Flask is running.
- Configured with Flask, no need to configure separately.
- Auto-discovery and management for plugins.
Install
Install Flask-Plugin using pip:
pip install flask-plugin
Quick Start
-
Entering the
example
directory, you will find the following directory structure, the pluginhello
insideplugins
directory:example ├── app.py └── plugins └── hello ├── __init__.py └── plugin.json
-
The plugin manager is loaded in the
app.py
file, and the hello plugin is started:from flask import Flask from flask_plugin import PluginManager app = Flask(__name__) manager = PluginManager(app) plugin = manager.find(id_='962e3b6cd8b74d02a5a02f1e3651ef87') if plugin: manager.load(plugin) manager.start(plugin) ... # API Management code here app.run()
-
Define plugin info in
SayHello/plugin.json
file:{ "id": "962e3b6cd8b74d02a5a02f1e3651ef87", "domain": "hello", "plugin": { "name": "Greeting", "author": "Doge", "summary": "Hello Flask-Plugin." }, "releases": [] }
-
Instantiated the
Plugin
inSayHello/__init__.py
and define the route as you did inFlask
:from flask_plugin import Plugin from flask import redirect, url_for plugin = Plugin() ... # Other routes defined here @plugin.route('/say/<string:name>', methods=['GET']) def say(name: str): return 'Hello ' + name
-
Accessing
/plugins/hello/
and see the greeting:Hello Anonymous!
Stop the plugin with accessing
/api/stop/347336b4fcdd447985aec57f2bc5793c
, check url above again, and get aHTTP 404
error.
Documentation for Flask-Plugin avaliable on: Flask-Plugin Documentation
Thanks
This project is based on many open source projects of the Pallets group, and I would like to express my thanks here.
Also thanks to my family and friends.