Skip to content

Improve texts in readme, docs, summaries #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
almarklein merged 1 commit into from
Mar 25, 2026
Merged

Improve texts in readme, docs, summaries #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# jupyter_rfb

Remote Frame Buffer for Jupyter
Remote Frame Buffer for Python notebooks

[![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)
Expand All @@ -12,32 +12,28 @@ 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
Images that are generated at the server are streamed to the notebook
where they are shown. Standardized [events](https://pygfx.org/renderview/) (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.
This *remote-frame-buffer* approach is an effective method for
server-generated visualizations to be dispayed in notebook environments. For
example visualizations created by tools like vispy, datoviz, and 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.
that other libraries can extend for different purposes.


## Installation

To install use pip:
Jupyter_rfb requires Python 3.9 or higher. You can install it via pip:

$ pip install jupyter_rfb

For better performance, also ``pip install simplejpeg`` or ``pip install pillow``.


## Developer notes

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Welcome to the jupyter_rfb docs!
================================

The `jupyter_rfb` library provides a widget (an `anywidget` subclass)
The `jupyter_rfb` library provides a widget (based on `anywidget`)
that can be used in various notebook environments to implement
a *remote frame-buffer*.

Expand Down
7 changes: 3 additions & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ license = { file = "LICENSE" }
requires-python = ">=3.9"
authors = [{ name = "Almar Klein" }]
keywords = [
"ipython",
"jupyter",
"anywidget",
"notebook",
"remote frame buffer",
"canvas",
"visualization",
"widgets",
]
classifiers = [
"Development Status :: 4 - Beta",
"Framework :: IPython",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Topic :: Multimedia :: Graphics",
Expand Down
Loading