https://github.com/singingwolfboy/flask-sse

Server-Sent Events for Flask
https://github.com/singingwolfboy/flask-sse

Last synced: about 17 hours ago
JSON representation

Server-Sent Events for Flask

• Host: GitHub
• URL: https://github.com/singingwolfboy/flask-sse
• Owner: singingwolfboy
• License: mit
• Created: 2016-04-11T21:32:13.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-06-07T07:16:36.000Z (6 months ago)
• Last Synced: 2024-12-06T05:04:09.289Z (8 days ago)
• Language: Python
• Homepage: https://flask-sse.readthedocs.org
• Size: 27.3 KB
• Stars: 312
• Watchers: 8
• Forks: 46
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
Flask SSE |build-status| |coverage-status| |docs|

=================================================

A Flask extension for HTML5 `server-sent events`_ support, powered by Redis_.

Example of sending events:

.. code-block:: python

    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:

.. code-block:: javascript

    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. `_

.. _server-sent events: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events

.. _Redis: http://www.redis.io/

.. |build-status| image:: https://github.com/singingwolfboy/flask-sse/workflows/Test/badge.svg

   :target: https://github.com/singingwolfboy/flask-sse/actions?query=workflow%3ATest

   :alt: Build status

.. |coverage-status| image:: http://codecov.io/github/singingwolfboy/flask-sse/coverage.svg?branch=master

   :target: http://codecov.io/github/singingwolfboy/flask-sse?branch=master

   :alt: Test coverage

.. |docs| image:: https://readthedocs.org/projects/flask-sse/badge/?version=latest&style=flat

   :target: http://flask-sse.readthedocs.org/

   :alt: Documentation