This project is a monorepo containing the frontend components and extensions to build a chat in Jupyter.
Many components of this chat project come from jupyter-ai.
The typescript package is located in packages/jupyter-chat and builds an NPM
package named @jupyter/chat
.
This package provides a frontend library (using react), and is intended to be used by a jupyterlab extension to create a chat.
The typescript package is located in packages/jupyterlab-collaborative-chat and
builds an NPM package named jupyterlab-collaborative-chat
.
This package relies on @jupyter/chat
and provides a typescript library.
It is intended to be used by a jupyterlab extension to create a collaborative chat.
This extension is an implementation of the jupyter-collaborative-chat
package, relying
on shared document (see jupyter_ydoc).
It is composed of:
- a Python package named
jupyterlab_collaborative_chat
, which register theYChat
shared document in jupyter_ydoc - a NPM package named
jupyterlab-collaborative-chat-extension
.
This extension is an implementation of the @jupyter/chat
package, relying on
websocket for the communication between server and front end.
It is composed of a Python package named jupyterlab_ws_chat
for the server side and a NPM package named jupyterlab-ws-chat
.
See the contributing part of each package for details.