repo2jupyterlite icon indicating copy to clipboard operation
repo2jupyterlite copied to clipboard

Add a parameter to allow using Voici!

Open martinRenou opened this issue 2 years ago • 8 comments

Problem

It would be great to have an option to use the Voici jupyterlite addon https://github.com/voila-dashboards/voici so that people could generate dashboards easily!

martinRenou avatar May 17 '23 12:05 martinRenou

Maybe Voici could still be used with the jupyter lite build command via the addon configuration?

jtpio avatar May 17 '23 12:05 jtpio

Yes it can! It's a regular addon.

martinRenou avatar May 17 '23 13:05 martinRenou

Perfect! So we just need to document that the builder will look for this config file?

yuvipanda avatar May 17 '23 17:05 yuvipanda

I don't see from https://github.com/voila-dashboards/voici how to enable this with a jupyter_lite_config file. Is there an example?

yuvipanda avatar May 29 '23 07:05 yuvipanda

You just need Voici to be installed with pip and the Voici addon should load automatically. Then you can configure jupyterlite to build only Voici with the apps option being set to just ["voici"]

martinRenou avatar May 29 '23 08:05 martinRenou

Ah, I see. Should we just add that by default to all builds? Or detect that it is wanted somehow?

yuvipanda avatar May 29 '23 08:05 yuvipanda

It may be nice to be able to define build dependencies like Voici or jupyterlite-xeus-lua (or any other jupyterlite kernel) that would be installed by repo2jupyterlite automatically prior to building the lite output. Do you think that would be feasible? Otherwise installing voici by default may be the way to go.

martinRenou avatar May 29 '23 08:05 martinRenou

@martinRenou so I want to 'preserve' the meaning of environment.yml (and in the future, requirements.txt) to only count for things that are installed at runtime. Perhaps what we can do instead is to look for something that enables this in jupyter-lite.json or similar, and use that to install in the build env? I don't want to ship features to things that don't opt in for them.

yuvipanda avatar May 29 '23 08:05 yuvipanda