Voilite POC #1187

martinRenou · 2022-08-12T08:45:49Z

POC implementation for Voilite. Building on top of the lab-based PR #846

This PR implements a Voilite nbconvert exporter that will execute the code in the client using a client-side kernel.

jupyter nbconvert --to voilite_dashboard notebooks/basics.ipynb

Update 18/11

The nbconvert template is replaced by the voilite command. Users can convert a notebook into a static dashboard page with

voilite notebook.ipynb --theme=dark --template=gridstack --packages=ipywidgets --packages=ipyleaflet

Supported options:

--theme: Change the theme , can be dark, light or the full name of the JupyterLab themes.
--template: Change the template, for now Voilite supports lab, gridstack, reveal and classic theme
--packages: List of packages to be installed at run time in the lite kernel.

Voilite can be configured via the CLI or the voilite.py/voilite.json file.

Remaining tasks

Update classic and reveal templates to support voilite.
Handle static files
Generate a tree page for the case of multiple notebooks.
Improve loading message.
~~Add tests and documentation~~ (will be addressed in the follow-up PR )

martinRenou · 2022-08-12T08:45:54Z

This is very much WIP for now, there is not much to see yet.

github-actions · 2022-08-12T08:46:06Z

👈 Launch a Binder on branch martinRenou/voila/voilite

packages/voilite/index.js

packages/voilite/package.json

martinRenou · 2022-08-25T13:08:14Z

Sorry for the wild rebases/squashes. I was cleaning up the PR quite a bit. It's not yet ready for review.

trungleduc · 2022-10-07T12:37:47Z

@martinRenou do you have anything in the pipeline? Can rebase and play around with this PR?

martinRenou · 2022-10-07T12:43:37Z

Feel free to do it :)

I pushed all I have here. It's not complete, and not working.

trungleduc · 2022-10-14T16:24:03Z

Since this PR is based on #846 and it started diverging from the upstream PR. I think it's better to wait for #846 to be merged before continuing.
I will port some changes back to the upstream PR.

martinRenou · 2022-10-27T15:14:35Z

voila/voilite/app.py

+    def copy_static_files(self, page_config: Dict) -> None:
+
+        lite_static_path = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), 'static'
+        )
+        dest_static_path = os.path.join(os.getcwd(), 'voila')
+        if os.path.isdir(dest_static_path):
+            shutil.rmtree(dest_static_path)
+        copy_tree(
+            os.path.join(lite_static_path, 'voila'),
+            os.path.join(dest_static_path, 'static'),
+        )
+        shutil.move(
+            os.path.join(dest_static_path, 'static', 'pypi'),
+            os.path.join(dest_static_path, 'build', 'pypi'),
+        )
+        shutil.copyfile(
+            os.path.join(lite_static_path, 'services.js'),
+            os.path.join(dest_static_path, 'services.js'),
+        )
+
+        # Copy extension files
+        labextensions_path = jupyter_path('labextensions')
+        federated_extensions = page_config.get('federated_extensions', [])
+        roots = tuple(
+            os.path.abspath(os.path.expanduser(p)) + os.sep
+            for p in labextensions_path
+        )
+        dest_extension_path = os.path.join(
+            os.getcwd(), 'voila', 'labextensions'
+        )
+        if os.path.isdir(dest_extension_path):
+            shutil.rmtree(dest_extension_path)
+        for extension in federated_extensions:
+            for root in roots:
+                name = extension['name']
+                full_path = os.path.join(root, name)
+                if os.path.isdir(full_path):
+                    copy_tree(
+                        full_path, os.path.join(dest_extension_path, name)
+                    )
+
+        # Copy themes files
+        all_themes = find_all_lab_theme()
+        for theme in all_themes:
+            theme_dst = os.path.join(
+                dest_static_path, 'static', 'themes', theme[0]
+            )
+            copy_tree(theme[1], theme_dst)


We might be able to get rid of all this if we make it a JupyterLite addon?

I'm not very familiar with JupyterLite, does that mean Voila will depend on JupyterLite?

The xeus python lite kernel is a good example of a JupyterLite addon: https://github.com/jupyterlite/xeus-python-kernel/blob/main/jupyterlite_xeus_python/env_build_addon.py

We could probably make voilite and voila two specific Python packages so that we don't make voila depend on jupyterlite

Frankly, I'm not a fan of splitting voila/voilite, even at the command level.
I would love to be able to switch seamlessly between the two versions in the same voila command. It would be even better if we can mix the two types together on the same page. For example, when we serve a directory of notebooks we can config (by voila.json, voila.py,...) which ones will be served by the normal voila, and which one by the lite version.

voila/voilite/exporter.py

share/jupyter/voila/templates/lab/index.html.j2

jtpio · 2022-11-23T12:40:10Z

Many thanks @trungleduc for picking this up, will have a look soon 👍

martinRenou · 2022-12-07T09:54:07Z

There seems to be an error when passing a directory to voilite:

$ voilite notebooks/
Traceback (most recent call last):
  File "/home/martinrenou/micromamba/envs/voila/bin/voilite", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/home/martinrenou/micromamba/envs/voila/lib/python3.11/site-packages/traitlets/config/application.py", line 985, in launch_instance
    app.start()
  File "/home/martinrenou/github/voila/voila/voilite/app.py", line 369, in start
    self.convert_directory(page_config)
  File "/home/martinrenou/github/voila/voila/voilite/app.py", line 330, in convert_directory
    self.convert_notebook(
  File "/home/martinrenou/github/voila/voila/voilite/app.py", line 294, in convert_notebook
    with open(nb_path) as f:
         ^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'basics.ipynb'

trungleduc · 2022-12-12T09:31:18Z

@martinRenou @jtpio to reuse jupyterlite addons, I think it would be better to spit voilite into a standalone package. What do you think?

martinRenou · 2022-12-12T09:32:26Z

I'm personally fine with that 👍🏽

jiboncom · 2023-01-11T13:53:41Z

Hello all,
This looks amazing! I was trying to install from the PR but I am having a problem building the package. I always get a
ValueError: Aborting. Could not find cmd (jlpm) in path. If command is not expected to be in user's path, use an absolute path.

Any ideas on how to fix it?

trungleduc · 2023-01-11T14:03:13Z

Hello all, This looks amazing! I was trying to install from the PR but I am having a problem building the package. I always get a ValueError: Aborting. Could not find cmd (jlpm) in path. If command is not expected to be in user's path, use an absolute path.

Any ideas on how to fix it?

you can alias your yarn command to jlpm or just install jupyterlab, it comes with the jlpm command.

jiboncom · 2023-01-11T17:28:30Z

Hello all, This looks amazing! I was trying to install from the PR but I am having a problem building the package. I always get a ValueError: Aborting. Could not find cmd (jlpm) in path. If command is not expected to be in user's path, use an absolute path.
Any ideas on how to fix it?

you can alias your yarn command to jlpm or just install jupyterlab, it comes with the jlpm command.

Thanks, it worked! This is absolutely great and could allow us to easily deploy dashboards to hundreds of students simultaneously! Many thanks for all your work.

I would like to suggest one potential improvement/feature although I have no idea about how hard it would be to implement. It would be great to first quickly show a cached output of the notebook/dashboard and have something signal the kernel still is loading. This way, people quickly get something to see and start exploring the dashboard instead of first having to wait and only then start discovering the content. I see it as the equivalent of the preheated kernels (although not the same, of course!).

Yours thankfully,
Javier.

trungleduc · 2023-01-12T09:35:28Z

Hello all, This looks amazing! I was trying to install from the PR but I am having a problem building the package. I always get a ValueError: Aborting. Could not find cmd (jlpm) in path. If command is not expected to be in user's path, use an absolute path.
Any ideas on how to fix it?

you can alias your yarn command to jlpm or just install jupyterlab, it comes with the jlpm command.

Thanks, it worked! This is absolutely great and could allow us to easily deploy dashboards to hundreds of students simultaneously! Many thanks for all your work.

I would like to suggest one potential improvement/feature although I have no idea about how hard it would be to implement. It would be great to first quickly show a cached output of the notebook/dashboard and have something signal the kernel still is loading. This way, people quickly get something to see and start exploring the dashboard instead of first having to wait and only then start discovering the content. I see it as the equivalent of the preheated kernels (although not the same, of course!).

Yours thankfully, Javier.

Thanks for your feedback, indeed the preview output is a great idea! I will take a look at it.

martinRenou · 2023-02-20T09:49:47Z

Let's merge and iterate in follow-up PRs!

martinRenou · 2023-02-20T10:42:59Z

As discussed with @trungleduc, we will revert this merge and create a new repository for Voilite.

This reverts commit 0b013b4.

martinRenou commented Aug 12, 2022

View reviewed changes

packages/voilite/index.js Outdated Show resolved Hide resolved

packages/voilite/package.json Outdated Show resolved Hide resolved

jtpio added the enhancement New feature or request label Aug 17, 2022

martinRenou mentioned this pull request Aug 18, 2022

Voila + JupyterLite jupyterlite/jupyterlite#773

Closed

martinRenou force-pushed the voilite branch 4 times, most recently from 21a9222 to cb28723 Compare August 25, 2022 13:07

martinRenou mentioned this pull request Aug 25, 2022

WIP: Voilite app jupyterlite/jupyterlite#781

Closed

martinRenou force-pushed the voilite branch from cb28723 to d6447d0 Compare August 26, 2022 07:37

jtpio mentioned this pull request Aug 26, 2022

Troubleshoot docs build #1190

Closed

trungleduc force-pushed the voilite branch from e27330a to 1063ba1 Compare October 10, 2022 20:09

martinRenou force-pushed the voilite branch from 077631a to a552320 Compare October 27, 2022 15:12

martinRenou commented Oct 27, 2022

View reviewed changes

trungleduc added this to the 0.5.0 milestone Oct 28, 2022

martinRenou mentioned this pull request Oct 28, 2022

0.5.0 Release Plan #1245

Closed

martinRenou commented Oct 31, 2022

View reviewed changes

voila/voilite/exporter.py Outdated Show resolved Hide resolved

share/jupyter/voila/templates/lab/index.html.j2 Outdated Show resolved Hide resolved

trungleduc force-pushed the voilite branch 2 times, most recently from 0e75bed to ab3b9ad Compare November 8, 2022 14:59

trungleduc added the new label Nov 8, 2022

trungleduc force-pushed the voilite branch 3 times, most recently from 8919dde to e497316 Compare November 14, 2022 21:17

trungleduc force-pushed the voilite branch 2 times, most recently from 03ed782 to fbb57e1 Compare November 17, 2022 15:39

jtpio self-requested a review November 23, 2022 12:40

trungleduc self-assigned this Jan 30, 2023

trungleduc added 10 commits February 20, 2023 10:08

Create voilite package

d81c6b8

Update templates

0615298

Use plugins from voila

f2a2fc9

Update build directory

052202c

Render tree page

433a59e

[WIP] Support lab theme in tree page

302a858

Switch to CSS-based style for light and dark theme

6f73e67

Handle static files

9ec19bd

Update reveal and classic template

ae75425

Add option to install dependencies from CLI

9b3bb1b

martinRenou force-pushed the voilite branch from 22bea83 to 9b3bb1b Compare February 20, 2023 09:08

martinRenou merged commit 0b013b4 into voila-dashboards:main Feb 20, 2023

martinRenou deleted the voilite branch February 20, 2023 09:50

martinRenou added a commit that referenced this pull request Feb 20, 2023

Revert "Voilite POC (#1187)"

454c0af

This reverts commit 0b013b4.

martinRenou mentioned this pull request Feb 20, 2023

Revert "Voilite POC" #1289

Merged

martinRenou added a commit that referenced this pull request Feb 20, 2023

Revert "Voilite POC (#1187)" (#1289)

8540636

This reverts commit 0b013b4.

martinRenou mentioned this pull request Feb 21, 2023

Extendable voila #1290

Merged

wragge mentioned this pull request Apr 22, 2023

Provide Jupyterlite as an option where possible GLAM-Workbench/glam-workbench.github.io#64

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Voilite POC #1187

Voilite POC #1187

martinRenou commented Aug 12, 2022 •

edited by trungleduc

martinRenou commented Aug 12, 2022

github-actions bot commented Aug 12, 2022

martinRenou commented Aug 25, 2022

trungleduc commented Oct 7, 2022

martinRenou commented Oct 7, 2022

trungleduc commented Oct 14, 2022

martinRenou Oct 27, 2022

trungleduc Oct 28, 2022

jtpio Oct 28, 2022

martinRenou Oct 28, 2022

trungleduc Oct 28, 2022

jtpio commented Nov 23, 2022

martinRenou commented Dec 7, 2022

trungleduc commented Dec 12, 2022

martinRenou commented Dec 12, 2022

jiboncom commented Jan 11, 2023

trungleduc commented Jan 11, 2023

jiboncom commented Jan 11, 2023

trungleduc commented Jan 12, 2023

martinRenou commented Feb 20, 2023

martinRenou commented Feb 20, 2023

Voilite POC #1187

Voilite POC #1187

Conversation

martinRenou commented Aug 12, 2022 • edited by trungleduc

Update 18/11

martinRenou commented Aug 12, 2022

github-actions bot commented Aug 12, 2022

martinRenou commented Aug 25, 2022

trungleduc commented Oct 7, 2022

martinRenou commented Oct 7, 2022

trungleduc commented Oct 14, 2022

martinRenou Oct 27, 2022

Choose a reason for hiding this comment

trungleduc Oct 28, 2022

Choose a reason for hiding this comment

jtpio Oct 28, 2022

Choose a reason for hiding this comment

martinRenou Oct 28, 2022

Choose a reason for hiding this comment

trungleduc Oct 28, 2022

Choose a reason for hiding this comment

jtpio commented Nov 23, 2022

martinRenou commented Dec 7, 2022

trungleduc commented Dec 12, 2022

martinRenou commented Dec 12, 2022

jiboncom commented Jan 11, 2023

trungleduc commented Jan 11, 2023

jiboncom commented Jan 11, 2023

trungleduc commented Jan 12, 2023

martinRenou commented Feb 20, 2023

martinRenou commented Feb 20, 2023

martinRenou commented Aug 12, 2022 •

edited by trungleduc