WSRPC

Bidirectional remote procedure calls over WebSockets. A Python or JavaScript peer can expose methods, call the other peer and receive results, errors or events over one connection.

Get started: install a package, choose your framework tab, and run the same RPC call from Python or a browser. Examples cover aiohttp, FastAPI, Starlette, Django, Channels, Quart, Litestar, Falcon, Sanic, BlackSheep and bare ASGI.

Both implementations use the same WSRPC protocol. Existing Python and JavaScript clients can connect across the two server transports. The client guide shows those choices; the compatibility guide explains the Python API differences.

Getting started

• Quick start
  • Install
  • Define the RPC methods
  • Connect your server
  • Call from Python
  • Call from a browser
• Protocol and connection model
  • Requests and replies
  • Events and binary messages
  • Routes and keepalive
• Python and JavaScript clients
  • Python
  • Browser
• Choosing a transport and migrating

Server integrations

• aiohttp server
  • Install
• ASGI server
  • FastAPI browser demo
  • ASGI integration details
  • Routes and connections
  • Signals
  • Migrating from wsrpc-aiohttp
  • Developing the ASGI library
  • API reference

Contributing

• Maintaining the documentation

The Python projects are licensed under Apache-2.0; the bundled JavaScript client retains its MIT license. Maintained by Dmitry Orlov (orlovdl@gmail.com).