New approach for JupyterLab 3 #605

fcollonval · 2021-11-15T16:38:36Z

This is a reboot of #381 - in order to move forward on jupyter/notebook#6220

The approach taken differs from #381 as it creates a stand-alone app (similarly to retrolab - JLab remix) in order to:

Deal with the DOM manipulation induced by RevealJS that don't play nicely in webapp such JupyterLab
Add the opportunity to spin a notebook focusing on slideshow experience

What it does:

Add button in JupyterLab notebook toolbar to open the RISE view of the current notebook
Support federated extension in RISE mode (in particular ipywidgets are working)
Restructure completely the package to be a single python package with multiple npm packages to ship a single package for the classical notebook and JupyterLab
Support ipywidget
Run on Binder for the classical notebook and JupyterLab ~~(but failed to open the standalone app from JupyterLab)~~

What it partly do:

Create a ugly slideshow with no configuration

What needs to be done:

Help will be really appreciate to cover the above points - don't hesitate to open PRs against this PR branch.

fcollonval · 2021-11-15T16:52:01Z

Binder Link

parmentelat · 2021-11-15T17:31:41Z

sounds cool, but the binder looks broken, or what am I missing ?

fcollonval · 2021-11-15T19:02:11Z

Unfortunately it does not work on Binder... needs to set the redirection.

parmentelat · 2021-11-15T19:15:42Z

no big deal if binder won't work
this is going to give us an opportunityto run the code from source
how should we go about doing that ?

damianavila · 2021-11-15T19:20:24Z

This is AWESOME, @fcollonval!!
I will try to digest the content ASAP and provide feedback!!
At first, the standalone app is an interesting compromise to get people running on JLab ASAP.
Super excited about this, thanks again for the contribution!

fcollonval · 2021-11-16T09:02:55Z

sounds cool, but the binder looks broken, or what am I missing ?

@parmentelat I fixed Binder if you want to try.

parmentelat · 2021-11-16T09:53:27Z

@fcollonval this looks just great, it is several orders of magnitude better than anything we've been trying to do as a jlab extension; many thanks !

I have to honestly admit that I have not been able to cope with the jlab extension dev paradigm(s); so how do I setup a dev environment to proceed on your track ?

I tried this just now:

git switch jlab3
git rev-parse HEAD
→ 42a9d9aa501894ee2d02782c08d364c287d9a5f9
conda create -y -n rise python=3.9
conda activate rise
pip install jupyterlab
pip install .
jupyter lab --version
→ 3.2.3
jupyter lab

but unsurprisingly it does not seem to work, I can't see the RISE button and am getting this screenshot below

it feels real dumb, please enlighten me :)

parmentelat · 2021-11-16T09:59:10Z

on a totally different level, one thing that I had at some point considered - before realizing that developing a jlab extension was way beyond my skills - was to have the regular notebook and the rise view in 2 separate tabs
this way I thought ideally we would have gotten the notebook view and the rise view side-by-side, so as to, for example, have a live preview of the rendered slides while tweaking the notebook

this was imho the most important breakthrough that porting to a jlab extension could bring us

I'm not quite sure this is doable at all though, so if this rings any bell wrt this new angle, please elaborate on the feasibility of that idea :)

fcollonval · 2021-11-16T11:04:25Z

how do I setup a dev environment to proceed on your track ?

Here are the commands to execute (I updated the dev note):

    yarn install
    yarn run build
    pip install -e .
    jupyter server extension enable rise
    jupyter serverextension enable rise
    jupyter labextension develop --overwrite .
    jupyter-nbextension install rise --py --sys-prefix --symlink
    jupyter-nbextension enable rise --py --sys-prefix

the notebook view and the rise view side-by-side

This should be achievable with the new approach by rendering the presentation in a IFrame like the voila preview

Edit: correct command for dev mode

parmentelat · 2021-11-16T12:26:22Z

Hi
thanks for the dev recipe
I've just given that a try and am getting mixed results
I do see the new extension button now, but that gives me a 404 not found - just like the first gif above in fact
not sure how to troubleshoot that issue though

fcollonval · 2021-11-16T13:46:15Z

You may need to install the server extension for the old notebook based server with:

jupyter server extension enable rise

parmentelat · 2021-11-16T15:52:11Z

yes, this last command does the trick !

damianavila · 2022-03-20T21:04:54Z

@damianavila I discuss with @parmentelat about creating a dedicated Python package for the JupyterLab version (keep everything in this repo but with two python packages).

I think that is a good idea.

The idea is to publish and iterate on the jupyterlab version in a simple way for users not comfortable with JavaScript tooling. Are you ok with that idea?

Can you please expand on that idea?
See my comment here about how I envision the next steps for RISE: #614 (comment) and #614 (comment).

Do you agree/disagree? Thoughts?

If so, should we merge the iteration on the master branch of this repo or iterate on a separate branch (I would prefer using master to reduce complexity for contributors)?

Which iteration are you referring to? The one creating the 2 packages?

Would you be willing to extend my rights on this repo to help with the maintenance?

OBVIOUSLY, already done!!

damianavila · 2022-03-20T21:06:43Z

Maybe we should continue the above conversation in #614, so we keep this one specifically for the content of this PR...

datakurre · 2022-03-27T13:52:52Z

@fcollonval Should it be already possible to run this with JupyterLite with some configuration? (With defaults I do get the button, but it eventually fails due to backend server route not being there with lite.)

bollwyvl · 2022-03-31T15:58:45Z

run this with JupyterLite

I'd wager this wouldn't work in Lite yet.

As the actual renderer is a whole separate lumino app/shell (akin to retro or lab) it would need a separate app/slides/index.ts which was aware of the shortcomings of the browser (e.g. can't list files in a directory) and worked around them (replacing the fetch implementation), but still able to load federated extensions like widgets.

The iframe preview capability from within lab might work, but many HTTP hosts have issues with same-origin iframes, no matter what we set on the sandbox... while the notebook contents might update if changed, the kernel state would not be shared until we figure out a way to launch them inside serviceworkers, or somehow coordinated iframes.

That being said, having a /slides/?path=Notebook.ipynb would be something that we should strongly consider enabling in the core lite repo: the nominal cost for the baseline app would be very low likely (~100kb), as all the apps (lab, retro and repl) are all part of a single shared webpack build, and the actual rendering parts would work as "just" a federated extension.

krassowski

I gave it a spin today, it's really cool! I noted one problem which likely needs fixing before a release - when other extensions are installed they can get added into the RISE preview area (I suggested a fix in the comment).

Otherwise I am happy with the UX. I would be even more happy if the font size in RISE and style were more consistent with notebook (e.g. lists and tables are very small while other markdown text is huge by comparison) but this might be for another time.

krassowski · 2022-06-21T19:53:22Z

packages/application/src/app/index.ts

+/**
+ * The Rise application shell token.
+ */
+export const IRetroShell = new Token<RiseShell>('rise-application:IRiseShell');


Suggested change

export const IRetroShell = new Token<RiseShell>('rise-application:IRiseShell');

export const IRiseShell = new Token<RiseShell>('rise-application:IRiseShell');

krassowski · 2022-06-21T20:04:01Z

packages/application/src/app/index.ts

+      // pass no-op
+    }
+    BoxLayout.setStretch(widget, 1);
+    (this.layout as BoxLayout).addWidget(widget);


I believe that the intention was that only custom notebook would get added, but my citation manager reference browser gets added:

This happens after the following call: app.shell.add(referenceBrowser, 'left', { rank: 850 }); in jupyterlab-citation-manager. You would have noted this with other federated extensions like jupyterlab-git which also add themselves to the shell in the left area, but you likely did not because they failed to activate (e.g. Plugin '@jupyterlab/git:plugin' failed to activate.) as they requires tokens which are not provided in this context, whereas jupyterlab-citation-manager is not fussy and has all tokens (except for INotebookTracker) optional.

I would suggest to add if (area == 'rise') { or at the very least if (area == 'main') {.

krassowski · 2022-06-21T20:06:44Z

packages/application/src/plugins/rise.ts

+      // Remove the toolbar
+      notebookPanel.toolbar.dispose();
+
+      app.shell.add(notebookPanel);


Maybe

Suggested change

app.shell.add(notebookPanel);

app.shell.add(notebookPanel, 'rise');

see my comment on packages/application/src/app/index.ts.

krassowski · 2022-06-21T20:13:06Z

packages/lab/src/preview.ts

+        `<input name="renderOnSave" type="checkbox"></input>${trans.__(
+          'Render on Save'
+        )}`


I would suggest adding a class name + style to move the checkbox a little bit down (e.g. top: 4px; position: relative;) as it is currently out of line:

* extend examples/README to test tables * tentative fix for <li> elements that are too small

YiqinZhang · 2022-07-06T16:54:21Z

I had a problem with the chalkboard. The two buttons only work as jumping to the first slide, and the pen did not show up. I use Chrom(103.0.5060.53) and Firefox(102.0 (64-bit)) on Fedora36, and installed packages are listed below:

IPython          : 8.4.0
ipykernel        : 6.15.0
ipywidgets       : 7.7.1
jupyter_client   : 7.3.4
jupyter_core     : 4.10.0
jupyter_server   : 1.18.0
jupyterlab       : 3.1.18
nbclient         : 0.6.4
nbconvert        : 6.5.0
nbformat         : 5.4.0
notebook         : 6.4.12
qtconsole        : not installed
traitlets        : 5.3.0

Also, I found that the 'Notes only mode' does not work in the speaker's view. The Notes cells didn't show in the speaker notes but appeared on the slideshow. The same situation happens in the Binder as well.

And out of curiosity, are there any updates on the black theme?

Many thanks!

connorferster · 2022-07-12T05:19:15Z

Nothing productive to add. I just want to say I am very excited for this! Thank you @fcollonval @damianavila @parmentelat @krassowski for all of your work on this.

YiqinZhang · 2022-07-29T15:25:07Z

I found that the 'Notes only mode' does not work in the speaker's view. The Notes cells didn't show in the speaker notes but appeared on the slideshow. The same situation happens in the Binder as well.

I've tried to fix showing notes in Speak notes Speaker notes here. fcollonval#5
@fcollonval

PS: After reinstalling the chalkboard patch, the chalkboard and draw functions perform properly.

Co-authored-by: YiqinZhang <yiqinzhang@crc-dot1x-nat-10-239-213-212.bu.edu>

fcollonval · 2022-08-05T09:23:27Z

Thanks a lot @YiqinZhang I merged your PR

jim-smith · 2022-08-19T17:01:45Z

Problem opening second notebook as RISE presentation

hi all,
really excited about this as the loveliness of RISE for my teaching is stopping me fully making the transition to jupyterlab (Which I use for research and day-to-day stuff).

After following the right instructions (readme in the branch) I got this up and running nicely ...
but it only works for the first notebook I open .

After that, when I try to open a second, then select the rise button I see this message in the terminal from which I started Jupiter lab

[IPKernelApp] ERROR | No such comm target registered: jupyter.widget.control

Closing Jupyter and restarting lets me open the second notebook quite happily, - it doesn't seem to be anything to do with specific notebooks, just that closing one and starting another somehow loses track of the widgets ...

Also it doesn't work if I leave the first notebook running in rise mode then open another notebook and try to switch to rise in that.

Any help gratefully accepted as my weekly lecture tend to be split into three notebooks to match the short video chunks I make from them. (obviously I can shutdown and restart the Jupiter server as a workaround but this is not ideal)

YiqinZhang · 2022-08-25T20:51:52Z

I tried the keyboard shortcut and found both the keyboards "," for Hide/show RISE buttons and "?" for Help did not work as expected. In the notebook version, we can use "," to toggle all RISE buttons, but the hard-wired keyboard binding did not work in Jlab. Any thoughts about that?

YiqinZhang · 2022-08-29T19:19:03Z

I tried to fix toggling all RISE buttons so that the RISE controls won't cover the slide contents. And then bind keyboard "m" to hide/show buttons on the slideshow. fcollonval#6

nthiery · 2022-10-02T20:13:00Z

Hi!

Thanks so much for your work on rise on jupyterlab; we transitioned our
large classes here in Orsay to JupyterLab this semester, but we still need
to get back to Jupyter for our lectures. Not super convenient, but it's ok.

Where it gets a bit more complicated is that, in the spring semester, it's not
just the lecturers that use Jupyter slides, but also students for their project
presentations.

Do you have an idea at this stage whether there is a chance for rise to
be functional in JupyterLab by then, even with some rough corners? No
pressure intended; it's just to know and start planning a plan B if needed.

Thanks in advance!
Nicolas

echarles · 2022-10-30T07:40:42Z

Hi there, is anyone actively working on this? If not, any continue the work with more forces?

damianavila · 2022-11-07T03:34:48Z

Sorry for the long silence folks, I did not have time to push forward on this one, regrettably.
I do not want to make any promises but I plan to spend a few cycles working on this one in the coming weeks.

@fcollonval, do you think you will have some cycles to review my changes in the coming weeks? Just trying to understand if I will have feedback from you or if I would need to figure out things for myself 😉.

Btw, I would also like to discuss with you how the story would look like for the new notebook...
Since the approach here is based on a stand-alone app, it should be relatively straightforward to "migrate" it to the new notebook, right?

fcollonval · 2022-11-07T08:27:09Z

@fcollonval, do you think you will have some cycles to review my changes in the coming weeks? Just trying to understand if I will have feedback from you or if I would need to figure out things for myself wink.

I'll find time for that.

Btw, I would also like to discuss with you how the story would look like for the new notebook... Since the approach here is based on a stand-alone app, it should be relatively straightforward to "migrate" it to the new notebook, right?

Yes it should work (hopefully out of the box) in notebook v7.

fcollonval · 2022-12-11T16:36:11Z

Closing this as I extracted the plugin to its own repository (as the path forward was suggesting building a separate python package).

The Python package has been publish on PyPI.org: https://pypi.org/project/jupyterlab-rise
The repository is: https://github.com/jupyterlab-contrib/rise

LucaSoato · 2023-06-14T13:41:16Z

Hi everyone,
do you think it's compatible with JupyterLab 4?
Thanks for the great contribution there, guys ❤️

fcollonval added 17 commits November 12, 2021 13:50

First stand-alone app

0637903

Lab like app

b9151e4

Be sure Reveal layout takes over

bdb826e

Pass notebook path as part of URL

ecedeb9

Fix loading included files

a152583

Add widgets test case

94069ca

Reduce mandatory plugin list

06177d7

Add JupyterLab extension

d792bc5

Fix webpack shared scope

643638b

Rename classic to nbextension

4361160

Restructure the repo as one python pkg

cd75d28

Remove symlink

c5a4a45

Keep License and Readme as symlink

ee6dea9

Improve binder environment

62e1e6a

Lint code

d9b9cd8

Fix python sdist bdist

646b7e3

Pin package to JLab 3.0

77d9cde

Fix for binder

42a9d9a

jtpio mentioned this pull request Mar 29, 2022

Slideshow mode jupyterlab/jupyterlab#12022

Open

krassowski reviewed Jun 21, 2022

View reviewed changes

parmentelat mentioned this pull request Jun 22, 2022

fixing the size of <li> elements fcollonval/RISE#4

Merged

fixing the size of <li> elements (#4)

03071d4

* extend examples/README to test tables * tentative fix for <li> elements that are too small

fcollonval mentioned this pull request Jul 28, 2022

Weekly Team Meetings: Jul-Dec 2022 jupyterlab/frontends-team-compass#152

Closed

fix speaker notes (#5)

30554a9

Co-authored-by: YiqinZhang <yiqinzhang@crc-dot1x-nat-10-239-213-212.bu.edu>

trevorcampbell mentioned this pull request Sep 8, 2022

RISE not working on JupyterLab UBC-DSCI/dsci-100-infra#10

Closed

Fix toggle all RISE buttons on slides (#6)

023fd81

jtpio mentioned this pull request Nov 17, 2022

Support Notebook 7 deathbeds/jupyterlab-deck#36

Closed

fcollonval closed this Dec 11, 2022

krassowski mentioned this pull request Dec 21, 2022

jupyterlab-system-monitor renders [horribly] when rendering in skideshow mode jupyterlab-contrib/rise#4

Closed

damianavila mentioned this pull request Feb 20, 2023

Create a jupyter-slides (name to be discussed ;-) organization to house several Jupyter slideshows projects #635

Open

9 tasks

fcollonval mentioned this pull request Feb 26, 2023

Fix shell pollution by third party extension jupyterlab-contrib/rise#21

Merged

	export const IRetroShell = new Token<RiseShell>('rise-application:IRiseShell');
	export const IRiseShell = new Token<RiseShell>('rise-application:IRiseShell');

	app.shell.add(notebookPanel);
	app.shell.add(notebookPanel, 'rise');

New approach for JupyterLab 3 #605

New approach for JupyterLab 3 #605

Conversation

fcollonval commented Nov 15, 2021 • edited Loading

fcollonval commented Nov 15, 2021

parmentelat commented Nov 15, 2021

fcollonval commented Nov 15, 2021

parmentelat commented Nov 15, 2021

damianavila commented Nov 15, 2021 • edited Loading

fcollonval commented Nov 16, 2021

parmentelat commented Nov 16, 2021

parmentelat commented Nov 16, 2021

fcollonval commented Nov 16, 2021 • edited Loading

parmentelat commented Nov 16, 2021

fcollonval commented Nov 16, 2021

parmentelat commented Nov 16, 2021

damianavila commented Mar 20, 2022

damianavila commented Mar 20, 2022

datakurre commented Mar 27, 2022

bollwyvl commented Mar 31, 2022

krassowski left a comment

Choose a reason for hiding this comment

krassowski Jun 21, 2022

Choose a reason for hiding this comment

krassowski Jun 21, 2022 • edited Loading

Choose a reason for hiding this comment

krassowski Jun 21, 2022

Choose a reason for hiding this comment

krassowski Jun 21, 2022 • edited Loading

Choose a reason for hiding this comment

krassowski Jun 21, 2022

Choose a reason for hiding this comment

YiqinZhang commented Jul 6, 2022

connorferster commented Jul 12, 2022 • edited Loading

YiqinZhang commented Jul 29, 2022 • edited Loading

fcollonval commented Aug 5, 2022

jim-smith commented Aug 19, 2022

Problem opening second notebook as RISE presentation

YiqinZhang commented Aug 25, 2022

YiqinZhang commented Aug 29, 2022

nthiery commented Oct 2, 2022

echarles commented Oct 30, 2022

damianavila commented Nov 7, 2022

fcollonval commented Nov 7, 2022

fcollonval commented Dec 11, 2022

LucaSoato commented Jun 14, 2023

fcollonval commented Nov 15, 2021 •

edited

Loading

damianavila commented Nov 15, 2021 •

edited

Loading

fcollonval commented Nov 16, 2021 •

edited

Loading

krassowski Jun 21, 2022 •

edited

Loading

krassowski Jun 21, 2022 •

edited

Loading

connorferster commented Jul 12, 2022 •

edited

Loading

YiqinZhang commented Jul 29, 2022 •

edited

Loading