• Stars
    star
    167
  • Rank 226,635 (Top 5 %)
  • Language
    TypeScript
  • License
    BSD 3-Clause "New...
  • Created almost 2 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

RISE: "Live" Reveal.js JupyterLab Slideshow Extension

jupyterlab_rise

Extension status Github Actions Status Binder PyPI

RISE: "Live" Reveal.js JupyterLab Slideshow extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlab_rise

For JupyterLab 3.x, install version prior to 0.40.0:

pip install "jupyterlab_rise<0.40.0"

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_rise

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_rise directory
# Install package in development mode
pip install -e ".[test]"
# 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_rise
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_rise
pip uninstall jupyterlab_rise

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

Testing the extension

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

More Repositories

1

jupyterlab-variableInspector

Variable Inspector extension for Jupyterlab
TypeScript
1,096
star
2

jupyterlab_code_formatter

A JupyterLab plugin to facilitate invocation of code formatters.
Python
833
star
3

jupyterlab-vim

Vim notebook cell bindings for JupyterLab
TypeScript
667
star
4

spellchecker

Spellchecker for JupyterLab notebook markdown cells and file editor.
TypeScript
205
star
5

jupyterlab-spreadsheet-editor

JupyterLab spreadsheet editor for tabular data (e.g. csv, tsv)
TypeScript
130
star
6

jupyterlab-topbar

JupyterLab Top Bar extensions
TypeScript
106
star
7

jupyterlab-kernelspy

A Jupyter Lab extension for inspecting messages to/from a kernel
TypeScript
81
star
8

jupyterlab-quickopen

Quickly open a file in JupyterLab by typing part of its name
TypeScript
81
star
9

jupyterlab-unfold

An IDE-like file browser for JupyterLab
TypeScript
80
star
10

jupyter-archive

A Jupyter/Jupyterlab extension to make, download and extract archive files.
Python
76
star
11

jupyter-videochat

Video chat with peers inside JupyterLab
TypeScript
60
star
12

jupyterlab-tour

A JupyterLab UI tour built on jupyterlab-tutorial and react-joyride.
TypeScript
59
star
13

jupyterlab-link-share

JupyterLab Extension to easily share a link to a running server on Binder
TypeScript
53
star
14

jupyterlab-contrib.github.io

Management and website of JupyterLab Unofficial Extensions and Tools
Smarty
41
star
15

jupyter-ui-toolkit

UI Toolkit for Jupyter
TypeScript
40
star
16

jupyterlab-cell-flash

JupyterLab extension to show a flash effect when a cell is executed ⚡ ✨
TypeScript
39
star
17

jlab-enhanced-cell-toolbar

A cell toolbar for JupyterLab.
TypeScript
39
star
18

jupyterlab-filesystem-access

[Experimental] Browse local files using the non-standard File System Access API
TypeScript
30
star
19

jlab-enhanced-launcher

Alternative launcher for JupyterLab
TypeScript
25
star
20

jupyterlab-app-cookiecutter

Kickstart your JupyterLab based standalone application 🚀
TypeScript
22
star
21

jupyterlab_toastify

Customize 'react-toastify' to integrate nicely in JupyterLab.
TypeScript
22
star
22

search-replace

Search and replace accross files
TypeScript
21
star
23

jupyterlab-theme-editor

Extension providing a theme editor where colors, font families and font sizes of the elements of the user interface can be varied
TypeScript
21
star
24

jupyterlab-favorites

Add the ability to save favorite folders to JupyterLab for quicker browsing
TypeScript
14
star
25

jupyterlab-open-url-parameter

JupyterLab extension to open files passed via a URL parameter.
TypeScript
10
star
26

jupyterlab-pytutor

Python Tutor extension for JupyterLab
TypeScript
9
star
27

jupyterlab-plugin-graph

JupyterLab extension to show an interactive dependency graph of the installed plugins
TypeScript
9
star
28

jupyterlab-fileopen

A JupyterLab extension that adds a shortcut for opening files using the OS file explorer
Python
7
star
29

jupyterlab-gitlab

A JupyterLab extension for browsing GitLab repositories
TypeScript
5
star
30

ipylgbst

A widget library for controlling LEGO® BOOST via web-bluetooth
Python
4
star
31

jlab-image-editor

Simple image editor for JupyterLab
TypeScript
4
star
32

jupyterlab-logout

Log out button for JupyterLab
Python
3
star
33

jupyterlab-code-toc

Table of Contents JupyterLab extension with code content
TypeScript
3
star
34

react-auth-google-example

Example enabling users to log in with Google Identity service for webapps.
TypeScript
1
star
35

jupyterlab-topbar-text

JupyterLab extension to display arbitrary text in the top bar
Python
1
star
36

.github

Health files for the @jupyterlab-contrib organization
1
star
37

jupyterlab-browser-storage

A JupyterLab Drive to save files in the browser storage.
TypeScript
1
star