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 ParaView_.
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!
Configure from environment variables
------------------------------------
Those only apply for the Python server and launcher.
* WSLINK_LAUNCHER_GET - If set to 1 this will enable the GET endpoint for session information
* WSLINK_LAUNCHER_DELETE - If set to 1 this will enable the DELETE endpoint for killing a running session
* WSLINK_MAX_MSG_SIZE - Number of bytes for a message size (default: 4194304)
* WSLINK_HEART_BEAT - Number of seconds between heartbeats (default: 30)
License
-------
Free to use in open-source and commercial projects, under the BSD-3-Clause license.
.. _github repo: https://github.com/kitware/wslink
.. _ParaView: https://www.paraview.org/
.. _VTK: http://www.vtk.org/
.. _websocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
Raw data
{
"_id": null,
"home_page": "https://github.com/kitware/wslink",
"name": "wslink",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "websocket javascript rpc pubsub",
"author": "Kitware, Inc.",
"author_email": "kitware@kitware.com",
"download_url": "https://files.pythonhosted.org/packages/cb/bd/8bc0f281a5885a51ca5d4cb07b353a683059cfa065d52ec4326595d0dfa0/wslink-2.0.2.tar.gz",
"platform": null,
"description": "wslink\n======\n\nWslink allows easy, bi-directional communication between a python server and a\njavascript client over a websocket_. The client can make RPC calls to the\nserver, and the server can publish messages to topics that the client can\nsubscribe to. The server can include binary attachments in these messages,\nwhich are communicated as a binary websocket message, avoiding the overhead of\nencoding and decoding.\n\nRPC and publish/subscribe\n-------------------------\n\nThe initial users of wslink driving its development are VTK_ and ParaView_.\nParaViewWeb and vtkWeb require:\n\n* RPC - a remote procedure call that can be fired by the client and return\n sometime later with a response from the server, possibly an error.\n\n* Publish/subscribe - client can subscribe to a topic provided by the server,\n possibly with a filter on the parts of interest. When the topic has updated\n results, the server publishes them to the client, without further action on\n the client's part.\n\nGet the whole story\n-------------------\n\nThis package is just the server side of wslink. See the `github repo`_ for\nthe full story - and to contribute or report issues!\n\nConfigure from environment variables\n------------------------------------\n\nThose only apply for the Python server and launcher.\n\n* WSLINK_LAUNCHER_GET - If set to 1 this will enable the GET endpoint for session information\n* WSLINK_LAUNCHER_DELETE - If set to 1 this will enable the DELETE endpoint for killing a running session\n* WSLINK_MAX_MSG_SIZE - Number of bytes for a message size (default: 4194304)\n* WSLINK_HEART_BEAT - Number of seconds between heartbeats (default: 30)\n\nLicense\n-------\nFree to use in open-source and commercial projects, under the BSD-3-Clause license.\n\n.. _github repo: https://github.com/kitware/wslink\n.. _ParaView: https://www.paraview.org/\n.. _VTK: http://www.vtk.org/\n.. _websocket: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Python/JavaScript library for communicating over WebSocket",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/kitware/wslink"
},
"split_keywords": [
"websocket",
"javascript",
"rpc",
"pubsub"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2cada28032d188e46f1f0785a612471145ada5ca1309d82f9d17bf195d49a546",
"md5": "4ca8f483b630369c47ebab6e5e144676",
"sha256": "8d7e193a8367fe39a2de37c739153270524555040ccb49cd86ad79ea9c30fc8a"
},
"downloads": -1,
"filename": "wslink-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ca8f483b630369c47ebab6e5e144676",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35129,
"upload_time": "2024-04-18T23:22:41",
"upload_time_iso_8601": "2024-04-18T23:22:41.077633Z",
"url": "https://files.pythonhosted.org/packages/2c/ad/a28032d188e46f1f0785a612471145ada5ca1309d82f9d17bf195d49a546/wslink-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cbbd8bc0f281a5885a51ca5d4cb07b353a683059cfa065d52ec4326595d0dfa0",
"md5": "09622790cbeab99b5c1a66fcabea1d03",
"sha256": "0626e6c1feef43d2ab9e2947448f89e1274a8b0c43573a992aa5faf20be30188"
},
"downloads": -1,
"filename": "wslink-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "09622790cbeab99b5c1a66fcabea1d03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30394,
"upload_time": "2024-04-18T23:22:43",
"upload_time_iso_8601": "2024-04-18T23:22:43.176012Z",
"url": "https://files.pythonhosted.org/packages/cb/bd/8bc0f281a5885a51ca5d4cb07b353a683059cfa065d52ec4326595d0dfa0/wslink-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 23:22:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kitware",
"github_project": "wslink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wslink"
}
JSON
