jupyterlab_chat
A chat extension based on shared documents.
This extension is composed of a Python package named jupyterlab_chat
for the server extension and a NPM package named jupyterlab-chat-extension
for the frontend extension.
This extension registers a YChat shared document, and associate the document to a
chat widget in the front end.
Requirements
- JupyterLab >= 4.0.0
Install
To install the extension, execute:
pip install jupyterlab_chat
Uninstall
To remove the extension, execute:
pip uninstall jupyterlab_chat
Troubleshoot
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
jupyter labextension list
Contributing
Development install
Note: You will need NodeJS to build the extension package.
The jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
yarn or npm in lieu of jlpm below.
# Clone the repo to your local environment
# Change directory to the jupyterlab_chat directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter-builder develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
jupyter lab build --minimize=False
Development uninstall
pip uninstall jupyterlab_chat
In development mode, you will also need to remove the symlink created by jupyter-builder develop
command. To find its location, you can run jupyter labextension list to figure out where the labextensions
folder is located. Then you can remove the symlink named jupyterlab-chat-extension within that folder.
Testing the extension
Frontend tests
This extension is using Jest for JavaScript code testing.
To execute them, execute:
jlpm
jlpm test
Integration tests
This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.
More information are provided within the ui-tests README.
Packaging the extension
See RELEASE
Release files for jupyterlab-chat 0.25.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jupyterlab_chat-0.25.1.tar.gz | 368.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jupyterlab_chat-0.25.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 585.1 kB
Release files / jupyterlab_chat-0.25.1.tar.gz
| Download URL | jupyterlab_chat-0.25.1.tar.gz |
|---|---|
| Size | 368.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d68d5018166073553a3721b962c293d96afe4678812c8e8566dd1b8640cf65c6
|
|
BLAKE2b-256 checksum How to use checksums |
ae157c12759a54308c0d387d0feee6e6573b1fdc1fd2731b8bc2008502e99e08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
Release files / jupyterlab_chat-0.25.1-py3-none-any.whl
| Download URL | jupyterlab_chat-0.25.1-py3-none-any.whl |
|---|---|
| Size | 216.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d7331aa2e0d4a9ccf9a4b2576d26696c4b93a0e5e0ebab35a11c19ab804edc29
|
|
BLAKE2b-256 checksum How to use checksums |
f175d8f628a4b2fe861a4864304c0c05a50d6ce05535e6228854b49f5b048db2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.14
|
