https://github.com/jupyterlab/jupyter-chat

An extension to add a chat panel to JupyterLab
https://github.com/jupyterlab/jupyter-chat

Last synced: 15 days ago
JSON representation

An extension to add a chat panel to JupyterLab

• Host: GitHub
• URL: https://github.com/jupyterlab/jupyter-chat
• Owner: jupyterlab
• License: bsd-3-clause
• Created: 2024-02-29T08:50:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-17T22:01:52.000Z (2 months ago)
• Last Synced: 2025-02-25T07:43:52.735Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://jupyter-chat.readthedocs.io/en/latest/
• Size: 1.86 MB
• Stars: 25
• Watchers: 8
• Forks: 10
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jupyter-chat

[![Github Actions Status](https://github.com/jupyterlab/jupyter-chat/workflows/Build/badge.svg)](https://github.com/jupyterlab/jupyter-chat/actions/workflows/build.yml)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter-chat/main?urlpath=lab)

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](https://github.com/jupyterlab/jupyter-ai).

![a screenshot showing the jupyter-chat extension used in two browser windows](https://github.com/jupyterlab/jupyter-chat/assets/591645/5dac0b00-43ed-4458-ab67-18207644b92b)

> [!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](https://pypi.org/project/jupyterlab-chat/).

```bash

pip install jupyterlab-chat

```

To uninstall the package:

```bash

pip uninstall jupyterlab-chat

```

> [!NOTE]

> The extension was released as [jupyterlab-collaborative-chat](https://pypi.org/project/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](https://github.com/jupyter-server/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](https://github.com/brichet/jupyterlab-ws-chat)

## Contributing

See the contributing part of the [documentation](https://jupyter-chat.readthedocs.io/en/latest/developers/contributing/index.html).