foxglove-websocket 0.0.6

Foxglove WebSocket server

Foxglove Studio WebSocket server

This package provides a server implementation of the Foxglove Studio WebSocket protocol, enabling Foxglove Studio to ingest arbitrary “live” streamed data.

The protocol is encoding-agnostic, i.e. it can support Protobuf messages, JSON messages, etc. (as long as the desired encoding is supported by both client and server).

Installation

$ pip install foxglove-websocket

Example servers

This package includes example servers demonstrating how to use JSON and Protobuf data. To install additional dependencies required for the examples, run:

$ pip install foxglove-websocket[examples]

The following script provides a simple example server which publishes messages on a single topic called example_msg, using JSON to encode message data and JSON Schema to describe the message layout.

To get started with the example server:

1. Run python -m foxglove_websocket.examples.json_server.
   or: Run python -m foxglove_websocket.examples.protobuf_server.

2. In a browser, open up https://studio.foxglove.dev and initiate a Foxglove WebSocket connection to ws://localhost:8765/.

Development

When developing or maintaining the foxglove-websocket package, it is recommended to use pipenv to manage development dependencies and virtualenv.

• Run pipenv install --dev to create a virtualenv and install development dependencies.
• Run pipenv shell to enter the virtualenv.