Flask bundle

Support for Flask in applauncher

Install: pip install flask_applauncher_bundle

Configuration example

flask:
  use_debugger: True
  port: {flask_port}
  host: {flask_host}
  cors: False,
  debug: False, # True for internal webserver, False to use with wsgi
  secret_key: "cHanGeME"

Usage

Flask can load resources by a modular way called Blueprints. Your application only has to provide a blueprint (with your controllers). Lets see how to do this.

from flask import Blueprint, jsonify
import zope.event
import applauncher.kernel
import inject
from flask_bundle import ApiBlueprints

my_blueprint = Blueprint(
    'myApp', __name__
)

@my_blueprint.route("/lol", methods=['GET'])
def my_app_get_index():
    return jsonify({"foo": "bar"})
    
# The bundle
class WebBundle(object):
    def __init__(self):
        # I dont need any configuration so I simply ignore the field config_mapping
        
        # We need to add our blueprint when the dependency injection is ready so
        # we need to listen for this event
        zope.event.subscribers.append(self.event_listener)

    def event_listener(self, event):
        if isinstance(event, applauncher.kernel.InjectorReadyEvent):
            # When the injection is ready, we fetch the blueprints array
            # provided by the FlaskBundle
            bp = inject.instance(ApiBlueprints)
            bp.append(my_blueprint)
            # that's all, later the FlaskBundle will configure this blueprint

#WSGI To use with a wsgi server, set the debug option to False (when debug is true, the interal web server of flask is used). Next in your main.py, where the kernel runs, use something like this:

from applauncher.kernel import Environments, Kernel
import flask_bundle
import myapp.bundle

bundle_list = [
    flask_bundle.FlaskBundle(),
    myapp.bundle.CueBundle(),
]

kernel = Kernel(Environments.DEVELOPMENT, bundle_list, configuration_file="config/config_web.yml")


app = flask_bundle.FlaskBundle.app

And run the uwsgi like this

uwsgi --protocol=uwsgi --processes=2 --threads=1 --socket=0.0.0.0:3031 --module="main:app"

#More For more information about creating webs with flask just check the flask documentation