Sanic sse package that adds Server-Sent Events compability to sanic application.
Project description
Sanic Server-Sent Events extension
A Sanic extension for HTML5 server-sent events support, inspired by flask-sse and aiohttp-sse.
Install
Installation process as simple as:
$ pip install sanic_sse
Example
Server example:
from http import HTTPStatus
from sanic import Sanic
from sanic.response import json, json_dumps
from sanic.exceptions import abort
from sanic_sse import Sse
# This function is optional callback before sse request
# You can use it for authorization purpose or something else
async def before_sse_request(request):
if request.headers.get("Auth", "") != "some_token":
abort(HTTPStatus.UNAUTHORIZED, "Bad auth token")
sanic_app = Sanic()
# The default sse url is /sse but you can set it via init argument url.
Sse(
sanic_app, url="/events", before_request_func=before_sse_request
) # or you can use init_app method
@sanic_app.route("/send", methods=["POST"])
async def send_event(request):
# if channel_id is None than event will be send to all subscribers
channel_id = request.json.get("channel_id")
# optional arguments: event_id - str, event - str, retry - int
# data should always be str
# also you can use sse_send_nowait for send event without waiting
try:
await request.app.sse_send(json_dumps(request.json), channel_id=channel_id)
except KeyError:
abort(HTTPStatus.NOT_FOUND, "channel not found")
return json({"status": "ok"})
if __name__ == "__main__":
sanic_app.run(host="0.0.0.0", port=8000)
Client example (powered by sseclient-py and requests):
import json
import pprint
import requests
import sseclient
url = "http://127.0.0.1:8000/events"
# you may set channel_id parameter to receive special events
# url = "http://127.0.0.1:8000/events?channel_id=foo"
response = requests.get(url, stream=True)
client = sseclient.SSEClient(response)
for event in client.events():
print(event.id)
print(event.event)
print(event.retry)
pprint.pprint(json.loads(event.data))
Requirements
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
sanic_sse-0.2.1.tar.gz
(7.1 kB
view hashes)
Built Distribution
sanic_sse-0.2.1-py3-none-any.whl
(14.8 kB
view hashes)
Close
Hashes for sanic_sse-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0b52ab697566044ae2b82b46afb4129c444d4cb846bf314886fb554dcaff9ed |
|
MD5 | 6c00e857132318b3a5348c7df3033788 |
|
BLAKE2b-256 | c80ee862dbe0e77ca7d84db24eb5206139498762e46ab0b1e3fa17fd08f48fbd |