Skip to main content

Redis-over-WebSocket API on top of websockets and aioredis

Project description

An extensible Redis-over-WebSocket API on top of websockets and aioredis.


For basic functionality:

pip install redis_websocket_api

With geo extension (filtering messages by extent, projection transformation):

pip install redis_websocket_api[geo]

Server-Side Usage

For a quick test you can run

python -m redis_websocket_api

to start a simple redis websocket api on ws://localhost:8765.

This does roughly the equivalant of:

from aioredis import from_url
from redis_websocket_api import WebsocketServer, WebsocketHandler

class PublishEverythingHandler(WebsocketHandler):

    def channel_is_allowed(self, channel_name):
        return True

    redis=from_url("redis:///", encoding="utf-8", decode_responses=True),

Have a look at examples/ for an example with the GeoCommandsMixin added.

Client-Side Usage


The default functionality provides the following interface to the web client (expecting the requests over a websocket connection):

  • GET key translates to hvals key
  • GET key hkey translates to hget key hkey
  • SUB key subscribes the websocket to a redis channel (using a single redis connection pool for all clients)
  • DEL key unsubscribes the client from the channel
  • PING causes a PONG response (to avoid timeouts)

Subclass of WebsocketHandler with GeoCommandsMixin added

By adding the GeoCommandsMixin the web client can use

  • BBOX left bottom right top to only receive GeoJSON features within this box plus all messages which are not valid GeoJSON
  • PROJECTION epsg:number causes all future GeoJSON features to be transformed to the given projection

See examples/ for how to use an extended WebsocketHandler subclass.

Geo commands are currently limited to LineString, Polygon, and Point geometries.

Note that the projection input and output coordinates will use the traditional GIS order, that is longitude, latitude for geographic CRS and easting, northing for most projected CRS. If you want the input and output axis order to strictly follow the definition of the CRS, use StrictAxisOrderGeoCommandsMixin instead of GeoCommandsMixin.

Build your own protocol

Using the commands listed above for communicating from client to server is completly optional and determinded by the Mixin classes added to the WebsocketHandlerBase.

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

redis-websocket-api-0.4.4.tar.gz (13.8 kB view hashes)

Uploaded Source

Built Distribution

redis_websocket_api-0.4.4-py3-none-any.whl (12.1 kB view hashes)

Uploaded Python 3

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