| Name | jupyter-rfb JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Remote Frame Buffer for Jupyter |
| upload_time | 2025-01-17 08:55:05 |
| maintainer | None |
| docs_url | None |
| author | Almar Klein |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2021-2025 - jupyter_rfb contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ipython
jupyter
remote frame buffer
visualization
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyter_rfb
Remote Frame Buffer for Jupyter
[](https://badge.fury.io/py/jupyter-rfb)
[](https://github.com/vispy/jupyter_rfb/actions)
[](https://mybinder.org/v2/gh/vispy/jupyter_rfb/main?urlpath=lab/tree/examples/hello_world.ipynb)
## Introduction
The `jupyter_rfb` library provides a widget (an `ipywidgets` subclass)
that can be used in the Jupyter notebook and in JupyterLab to implement
a remote frame-buffer.
Images that are generated at the server are streamed to the client
(Jupyter) where they are shown. Events (such as mouse interactions) are
streamed in the other direction, where the server can react by
generating new images.
This *remote-frame-buffer* approach can be an effective method for
server-generated visualizations to be dispayed in Jupyter notebook/lab. For
example visualization created by tools like vispy, datoviz or pygfx.
## Scope
The above defines the full scope of this library; it's a base widget
that other libraries can extend for different purposes. Consequently,
these libraries don't have to each invent a Jupyter widget, and in
*this* library we can focus on doing that one task really well.
## Installation
To install use pip:
$ pip install jupyter_rfb
For better performance, also ``pip install simplejpeg`` or ``pip install pillow``.
On older versions of Jupyter notebook/lab an extra step might be needed
to enable the widget.
To install into an existing conda environment:
$ conda install -c conda-forge jupyter-rfb
## Developer notes
See [the contributor guide](https://jupyter-rfb.readthedocs.io/en/stable/contributing.html) on how to install ``jupyter_rfb``
in a dev environment, and on how to contribute.
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-rfb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ipython, jupyter, remote frame buffer, visualization, widgets",
"author": "Almar Klein",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f8/f5/7055e9f853ddce29c14e097addad5deeeddeadfb8c1a3128d0c09346bc7c/jupyter_rfb-0.5.1.tar.gz",
"platform": null,
"description": "# jupyter_rfb\n\nRemote Frame Buffer for Jupyter\n\n[](https://badge.fury.io/py/jupyter-rfb)\n[](https://github.com/vispy/jupyter_rfb/actions)\n[](https://mybinder.org/v2/gh/vispy/jupyter_rfb/main?urlpath=lab/tree/examples/hello_world.ipynb)\n\n## Introduction\n\nThe `jupyter_rfb` library provides a widget (an `ipywidgets` subclass)\nthat can be used in the Jupyter notebook and in JupyterLab to implement\na remote frame-buffer.\n\nImages that are generated at the server are streamed to the client\n(Jupyter) where they are shown. Events (such as mouse interactions) are\nstreamed in the other direction, where the server can react by\ngenerating new images.\n\nThis *remote-frame-buffer* approach can be an effective method for\nserver-generated visualizations to be dispayed in Jupyter notebook/lab. For\nexample visualization created by tools like vispy, datoviz or pygfx.\n\n\n## Scope\n\nThe above defines the full scope of this library; it's a base widget\nthat other libraries can extend for different purposes. Consequently,\nthese libraries don't have to each invent a Jupyter widget, and in\n*this* library we can focus on doing that one task really well.\n\n\n## Installation\n\nTo install use pip:\n\n $ pip install jupyter_rfb\n\nFor better performance, also ``pip install simplejpeg`` or ``pip install pillow``.\nOn older versions of Jupyter notebook/lab an extra step might be needed\nto enable the widget.\n\nTo install into an existing conda environment:\n\n $ conda install -c conda-forge jupyter-rfb\n\n\n## Developer notes\n\nSee [the contributor guide](https://jupyter-rfb.readthedocs.io/en/stable/contributing.html) on how to install ``jupyter_rfb``\nin a dev environment, and on how to contribute.\n\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021-2025 - jupyter_rfb contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Remote Frame Buffer for Jupyter",
"version": "0.5.1",
"project_urls": {
"Documentation": "https://jupyter-rfb.readthedocs.io/en/stable/",
"Homepage": "https://github.com/vispy/jupyter_rfb",
"Repository": "https://github.com/vispy/jupyter_rfb"
},
"split_keywords": [
"ipython",
" jupyter",
" remote frame buffer",
" visualization",
" widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "774c753a41f8c33044f050f43ad44aead55f767d98688e4c437e5156c05a50a4",
"md5": "544d1e18ecada08792ceb48ca1e28b70",
"sha256": "60aa4c3c1a994e7a807affabc372e2a5be51c7d9223f6fc27a1f5a47171065ee"
},
"downloads": -1,
"filename": "jupyter_rfb-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "544d1e18ecada08792ceb48ca1e28b70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 30695,
"upload_time": "2025-01-17T08:55:01",
"upload_time_iso_8601": "2025-01-17T08:55:01.259965Z",
"url": "https://files.pythonhosted.org/packages/77/4c/753a41f8c33044f050f43ad44aead55f767d98688e4c437e5156c05a50a4/jupyter_rfb-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8f57055e9f853ddce29c14e097addad5deeeddeadfb8c1a3128d0c09346bc7c",
"md5": "9996c53725cf3e470e78dd6d39a0b958",
"sha256": "f0e6908420048490f95168cb20ccd658022b3f1601fd6932d610a95da31fa007"
},
"downloads": -1,
"filename": "jupyter_rfb-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "9996c53725cf3e470e78dd6d39a0b958",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 756050,
"upload_time": "2025-01-17T08:55:05",
"upload_time_iso_8601": "2025-01-17T08:55:05.738533Z",
"url": "https://files.pythonhosted.org/packages/f8/f5/7055e9f853ddce29c14e097addad5deeeddeadfb8c1a3128d0c09346bc7c/jupyter_rfb-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-17 08:55:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vispy",
"github_project": "jupyter_rfb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-rfb"
}
