Swim System Python Implementation

The Swim System Python implementation provides a standalone set of frameworks for building massively real-time streaming WARP clients.

The Swim Python Client is a streaming API client for linking to lanes of stateful Web Agents using the WARP protocol, enabling massively real-time applications that continuously synchronize all shared states with ping latency. WARP is like pub-sub without the broker, enabling every state of a Web API to be streamed, without interference from billions of queues.

Installation

pip install swimos

Usage

# Setting the value of a value lane on a remote agent.
import time

from swimos import SwimClient

with SwimClient() as swim_client:
    host_uri = 'ws://localhost:9001'
    node_uri = '/unit/foo'
    lane_uri = 'info'

    value_downlink = swim_client.downlink_value()
    value_downlink.set_host_uri('ws://localhost:9001')
    value_downlink.set_node_uri('/unit/foo')
    value_downlink.set_lane_uri('info')
    value_downlink.open()

    new_value = 'Hello from Python!'
    value_downlink.set(new_value)

    print('Stopping the client in 2 seconds')
    time.sleep(2)

Development

Dependencies

Code dependencies

pip install -r requirements.txt

Development tools dependencies

pip install -r requirements-dev.txt

Run unit tests

Basic:

1. Install async test package: pip install aiounittest
2. Run tests: python -m unittest

With coverage:

1. Install async test package: pip install aiounittest
2. Install coverage package: pip install coverage
3. Generate report: coverage run --source=swimos -m unittest
4. View report: coverage report -m

Run Lint

Manual

1. Install lint package: pip install flake8
2. Run checks: flake8

Automatic (before commit)

1. Install commit hook package: pip install pre-commit
2. Run hook installation: pre-commit install

Build package

Building package distribution

1. Install build package: pip install build
2. Run: python -m build

Releasing a new version

1. Add version tag: git tag VERSION (e.g. 0.1.0)
2. Push to remote: git push origin VERSION