README.md

jupyter-chat

This project is a monorepo containing:

• an extension to add a chat in jupyterlab
• the frontend components to build a chat extension for Jupyter application

Many components of this chat project come from jupyter-ai.

Warning

This project is still in early development stage and its API may change often before a stable release.

Install chat extension

The chat extension is available on PyPI.

pip install jupyterlab-chat

To uninstall the package:

pip uninstall jupyterlab-chat

Note

The extension was released as jupyterlab-collaborative-chat until version 0.5.0.

Composition

Typescript package

@jupyter/chat

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.

jupyterlab-chat

The typescript package is located in packages/jupyterlab-chat and builds an NPM package named jupyterlab-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 chat.

Jupyterlab extensions

Chat extension based on shared document: python/jupyterlab-chat

This extension is an implementation of the jupyter-chat package, relying on shared document (see jupyter_ydoc).

It is composed of:

• a Python package named jupyterlab_chat, which register the YChat shared document in jupyter_ydoc
• a NPM package named jupyterlab-chat-extension.

REMOVED - Chat extension based on websocket

This extension has been moved to its own repository

Contributing

See the contributing part of the documentation.