Skip to main content

A jupyterlab extension to add a Jitsi chat

Project description

jupyterlab-jitsi

Github Actions Status

A jupyterlab extension to add a Jitsi chat

This extension is composed of a Python package named jupyterlab-jitsi for the server extension and a NPM package named jupyterlab-jitsi for the frontend extension.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install jupyterlab-jitsi

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-jitsi

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-jitsi directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab-jitsi
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab-jitsi
pip uninstall jupyterlab-jitsi

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-jitsi within that folder.

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-jitsi-0.2.1.tar.gz (91.0 kB view details)

Uploaded Source

Built Distribution

jupyterlab_jitsi-0.2.1-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-jitsi-0.2.1.tar.gz.

File metadata

  • Download URL: jupyterlab-jitsi-0.2.1.tar.gz
  • Upload date:
  • Size: 91.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.2

File hashes

Hashes for jupyterlab-jitsi-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dba6492643b067ebec2a59e5826d4ff8ea4c85857d637218f8d695a65d0dee2d
MD5 7cbd14d22f3d010c8aac2b445d92936c
BLAKE2b-256 e499ceb7484f446a51c5819f8eb33f6aabb58312bf8c0e192c5edb8366a060c2

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_jitsi-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_jitsi-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.2

File hashes

Hashes for jupyterlab_jitsi-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d1d76ebd78300efb56596218aebc537fb26ef5a40a0646ab71bbbb06de16e11
MD5 6ae71b07cf6c873607d1cccc6eb247d5
BLAKE2b-256 e548c37087d91360653a1e5ad76dd65a17f3a40d08d554616cb75b9a52acdda1

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