Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

PEP8 Fixes

latest commit c2f58e01a4
Aaron Brady insom authored


A simple Flask extension for HTML5 server-sent events support, powered by Redis

The extension provides 2 things - a blueprint with a single route for streaming events, and a helper function to send messages to subscribers:

from flask import Flask, json
from flask.ext.sse import sse, send_event

app = Flask(__name__)
app.register_blueprint(sse, url_prefix='/stream')

def send_message()
    send_event('myevent', json.dumps({"message": "Hello!"}))

You can then subscribe to these events in a supported browser:

<!DOCTYPE html>
  <meta charset="utf-8" />
    var source = new EventSource("{{ url_for('') }}");
    source.addEventListener('myevent', function(e) {
        var data = JSON.parse(;
        // handle event
    }, false);

The source comes with a basic example

Clients can subscribe to different channels by setting 'channel' on the query string, which defaults to 'sse'. These correspond to redis channels.

def send_message()
    send_event('myevent', json.dumps({"line": "Something happened"}), channel='logs')


var source = new EventSource("{{ url_for(''), channel='logs' }}")    

Being a blueprint, you can attach a before_request handler to handle things like access control:

def check_access():
    if request.args.get('channel') == 'firehose' and not g.user.is_admin():


Redis connection details are read from the applications config using the following keys (defaults in [])

  • SSE_REDIS_HOST [localhost]
  • SSE_REDIS_PORT [6379]
  • SSE_REDIS_DB [0]


Subscribers will connect and block for a long time, so you should seriously consider running under an asynchronous WSGI server, such as gunicorn+gevent (like the example)


Inspired by django-sse

Something went wrong with that request. Please try again.