Getting Started

Swim is a full stack streaming application platform for building stateful services, streaming APIs, and real-time UIs. Streaming applications push differential state changes through the full application stack, eliminating the need for polling and streaming only what each client chooses to observe. Real-time UIs render live views of distributed application state.

Creating a real-time applications starts with Swim Client, a streaming API client for consuming multiplexed streaming APIs. It opens links to lanes of stateful Web Agents using the WARP protocol, enabling massively real-time applications that continuously synchronize all shared states with half ping latency. The client requires no configuration and makes opening links to Web Agents a cinch.


To begin using the Swim client, install the swimos package.

pip install swimos

Quick Start

Connecting to a lane of a remote Web Agent with the SwimClient can be done in just a few lines.

Import and initialize an instance of SwimClient.

from swimos import SwimClient

client = SwimClient()

Next, create a link for connecting to your remote Web Agent.

downlink = client.downlink_event()

Then provide your link with the nodeUri and `laneUri of the Web Agent to which you wish to connect.


And define a callback for handling messages received by the link.

async def custom_on_event(event):
    print(f'Link received event: {event}')


Finally, open your downlink.

Once the downlink is open, events should begin streaming into the application. Whether they arrive as a trickle or a flood, applications may use these messages to update their internal state, keeping them consistent with the shared state of the remote Web Agent in network real-time.