Skip to content

QuantStack/xwebrtc

Repository files navigation

xwebrtc

Travis Appveyor Binder

C++ backend for WebRTC in the Jupyter notebook/lab

xwebrtc is an early developer preview, and is not suitable for general usage yet. Features and implementation are subject to change.

Trying it online

To try out xwebrtc interactively in your web browser, just click on the binder link:

Binder

Installation

We provide a package for the mamba (or conda) package manager.

  • Installing xwebrtc and the C++ kernel
mamba install xeus-cling xwebrtc -c conda-forge

Then, the front-end extension must be installed for either the classic notebook or JupyterLab.

  • Installing the extensions for the classic notebook
mamba install widgetsnbextension -c conda-forge
mamba install ipywebrtc -c conda-forge

Installation from sources

Or you can directly install it from the sources if you have all the dependencies already installed:

cmake -D CMAKE_INSTALL_PREFIX=your_install_prefix
make install

Dependencies

All the dependencies of xleaflet are available for the mamba (or conda) package manager.

xwebrtc xwidgets xeus
master >=0.23.0,<25 >=0.24.1,<26
0.6.1 >=0.23.0,<25 >=0.24.1,<26
0.6.0 ~0.23.0 ~0.24.1
0.5.0 ~0.20.0 ~0.23.3
0.4.1 ~0.16.1 ~0.18.1
0.4.0 ~0.16.0 ~0.18.1
0.3.0 ~0.15.0 ~0.17.0
0.2.0 ~0.14.0 ~0.15.0

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.