Metadata-Version: 2.4
Name: jupyter-rfb
Version: 1.0.2
Summary: Remote Frame Buffer for Jupyter
Keywords: ipython,jupyter,remote frame buffer,visualization,widgets
Author: Almar Klein
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: IPython
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Multimedia :: Graphics
License-File: LICENSE
Requires-Dist: anywidget
Requires-Dist: numpy
Requires-Dist: simplejpeg; implementation_name != 'pypy'
Requires-Dist: build ; extra == "build"
Requires-Dist: flit ; extra == "build"
Requires-Dist: twine ; extra == "build"
Requires-Dist: jupyter_rfb[build, lint, tests, docs] ; extra == "dev"
Requires-Dist: numpy ; extra == "docs"
Requires-Dist: anywidget ; extra == "docs"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: nbsphinx ; extra == "docs"
Requires-Dist: ruff ; extra == "lint"
Requires-Dist: pre-commit ; extra == "lint"
Requires-Dist: pytest ; extra == "tests"
Project-URL: Documentation, https://jupyter-rfb.readthedocs.io/en/stable/
Project-URL: Homepage, https://github.com/vispy/jupyter_rfb
Project-URL: Repository, https://github.com/vispy/jupyter_rfb
Provides-Extra: build
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: lint
Provides-Extra: tests

# jupyter_rfb

Remote Frame Buffer for Jupyter

[![PyPI version](https://badge.fury.io/py/jupyter-rfb.svg)](https://badge.fury.io/py/jupyter-rfb)
[![CI](https://github.com/vispy/jupyter_rfb/actions/workflows/ci.yml/badge.svg)](https://github.com/vispy/jupyter_rfb/actions)
[![Binder](https://mybinder.org/badge_logo.svg)](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 `anywidget` subclass)
that can be used in various notebook environments to implement
a remote frame-buffer.

Images that are generated at the server are streamed to the client
(Jupyter) where they are shown. [Standardized](https://pygfx.org/renderview/) 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``.


## 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

