Skip to main content

Server-Sent Events for Flask

Project description

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

Example of sending events:

from flask import Flask
from flask_sse import sse

app = Flask(__name__)
app.config["REDIS_URL"] = "redis://localhost"
app.register_blueprint(sse, url_prefix='/stream')

@app.route('/send')
def send_message():
    sse.publish({"message": "Hello!"}, type='greeting')
    return "Message sent!"

To receive events on a webpage, use Javascript to connect to the event stream, like this:

var source = new EventSource("{{ url_for('sse.stream') }}");
source.addEventListener('greeting', function(event) {
    var data = JSON.parse(event.data);
    // do what you want with this data
}, false);

The full documentation for this project is hosted on ReadTheDocs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-SSE-1.0.0.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

Flask_SSE-1.0.0-py2.py3-none-any.whl (5.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-SSE-1.0.0.tar.gz.

File metadata

  • Download URL: Flask-SSE-1.0.0.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.2 CPython/3.8.6

File hashes

Hashes for Flask-SSE-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4f84714c2549a45e4f17bfc5f68ee8a9f298b22740a6844404d1c74551f2090d
MD5 abf245a2b250ef707c30fb0d501e2f9c
BLAKE2b-256 383182586853cb1c0fcc2b8b533891606a779acc0da7d4cda5c8d7f2c2b05a29

See more details on using hashes here.

File details

Details for the file Flask_SSE-1.0.0-py2.py3-none-any.whl.

File metadata

  • Download URL: Flask_SSE-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.2 CPython/3.8.6

File hashes

Hashes for Flask_SSE-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f86d7ecff0607333755c444130c395e7a133fb7ae6cf76fbd29b1da36d34776b
MD5 ca76365a57e16292f6c3bac6126f3266
BLAKE2b-256 7183f9fe86f554a153fdd300fb8027121d508a2177605bd158d967ddd7325948

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page