Python/JavaScript library for communicating over WebSocket
Project description
wslink
======
Wslink allows easy, bi-directional communication between a python server and a
javascript client over a websocket_. The client can make RPC calls to the
server, and the server can publish messages to topics that the client can
subscribe to. The server can include binary attachments in these messages,
which are communicated as a binary websocket message, avoiding the overhead of
encoding and decoding.
RPC and publish/subscribe
-------------------------
The initial users of wslink driving its development are VTK_ and ParaViewWeb_.
ParaViewWeb and vtkWeb require:
* RPC - a remote procedure call that can be fired by the client and return
sometime later with a response from the server, possibly an error.
* Publish/subscribe - client can subscribe to a topic provided by the server,
possibly with a filter on the parts of interest. When the topic has updated
results, the server publishes them to the client, without further action on
the client's part.
Get the whole story
-------------------
This package is just the server side of wslink. See the github repo_ for
the full story - and to contribute or report issues!
License
-------
Free to use in open-source and commercial projects, under the BSD-3-Clause license.
.. _github repo: https://github.com/kitware/wslink
.. _ParaViewWeb: https://www.paraview.org/web/
.. _VTK: http://www.vtk.org/
.. _websocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
======
Wslink allows easy, bi-directional communication between a python server and a
javascript client over a websocket_. The client can make RPC calls to the
server, and the server can publish messages to topics that the client can
subscribe to. The server can include binary attachments in these messages,
which are communicated as a binary websocket message, avoiding the overhead of
encoding and decoding.
RPC and publish/subscribe
-------------------------
The initial users of wslink driving its development are VTK_ and ParaViewWeb_.
ParaViewWeb and vtkWeb require:
* RPC - a remote procedure call that can be fired by the client and return
sometime later with a response from the server, possibly an error.
* Publish/subscribe - client can subscribe to a topic provided by the server,
possibly with a filter on the parts of interest. When the topic has updated
results, the server publishes them to the client, without further action on
the client's part.
Get the whole story
-------------------
This package is just the server side of wslink. See the github repo_ for
the full story - and to contribute or report issues!
License
-------
Free to use in open-source and commercial projects, under the BSD-3-Clause license.
.. _github repo: https://github.com/kitware/wslink
.. _ParaViewWeb: https://www.paraview.org/web/
.. _VTK: http://www.vtk.org/
.. _websocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wslink-0.1.0.tar.gz
(16.5 kB
view hashes)
Built Distribution
wslink-0.1.0-py2.py3-none-any.whl
(19.2 kB
view hashes)
Close
Hashes for wslink-0.1.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c9c2a380a796711cf73a663865b6da81bf4313c9569728b8157e480f91176722 |
|
| MD5 | 3109a9d476a68de280ea2f6135862a36 |
|
| BLAKE2b-256 | 1f54e35d08d24a9ca511dc5c6722568851425b322ce32e662d209df2ae35c02a |
