search

jupyterlite / repo2jupyterlite

Build jupyterlite apps out of repositories
BSD 3-Clause "New" or "Revised" License
27 stars 4 forks source link

Add a parameter to allow using Voici! #5

Open martinRenou opened 1 year ago

martinRenou commented 1 year ago

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!

jtpio commented 1 year ago

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

martinRenou commented 1 year ago

Yes it can! It's a regular addon.

yuvipanda commented 1 year ago

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

yuvipanda commented 1 year ago

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?

martinRenou commented 1 year ago

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"]

yuvipanda commented 1 year ago

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

martinRenou commented 1 year ago

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.

yuvipanda commented 1 year ago

@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.