Skip to main content

A chat extension based on shared documents

Project description

jupyterlab_collaborative_chat

Github Actions StatusBinder

A chat extension based on shared documents.

This extension is composed of a Python package named jupyterlab_collaborative_chat for the server extension and a NPM package named jupyterlab-collaborative-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.

screenshot

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_collaborative_chat

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_collaborative_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_collaborative_chat directory
# Install package in development mode
pip install -e ".[test]"
# Link your development version of the extension with JupyterLab
jupyter labextension 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_collaborative_chat

In development mode, you will also need to remove the symlink created by jupyter labextension 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-collaborative-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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_collaborative_chat-0.5.0.tar.gz (395.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_collaborative_chat-0.5.0.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_collaborative_chat-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5c7fb8b6886b1529c10fe0c6bb2e8bd9d959472c96e87c94f7a46ad810edd52e
MD5 90425deabd9274b1a3c534454509d928
BLAKE2b-256 a2222baae5880db4e7b5a88b2a1f3c12725fe0532bc29a4956e31c34016424cd

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_collaborative_chat-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_collaborative_chat-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6476d0da4721f461f2e89a501537bab50d3eb9350c8ba6ecbeb294404d932e4a
MD5 19a758127d8dd61a1ca300f2463a53fd
BLAKE2b-256 5eccc6235028f4aa4a8efbb4eca37cdbefad9b29406d9e0330893b8755d1b9fd

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page