voila-dashboards/voici-demo

Voici deployment template

Voici demo

Voici deployed as a static site to GitHub Pages, for demo purposes.

It uses jupyterlite-xeus to build the Emscripten environment, including the xeus-python kernel and run dependencies.

✨ Try it in your browser ✨

https://voila-dashboards.github.io/voici-demo

💡 How to make your own deployment

Screencast.from.2023-03-06.11-06-04.webm

Then your site will be published under https://{USERNAME}.github.io/{DEMO_REPO_NAME}

📦 How to install extra packages

You can pre-install extra packages by adding them to the environment.yml file.

For example, if you want to create a Voici deployment with NumPy and Matplotlib pre-installed, you would need to edit the environment.yml file as following:

name: voici
channels:
  - https://repo.mamba.pm/emscripten-forge
  - conda-forge
dependencies:
  - xeus-python
  - numpy
  - matplotlib

Only no-arch packages from conda-forge and packages from emscripten-forge can be installed.

• How do I know if a package is no-arch on conda-forge? no-arch means that the package is OS-independent, usually pure-python packages are no-arch. To check if your package is no-arch on conda-forge, check if the "Platform" entry is "no-arch" in the https://beta.mamba.pm/channels/conda-forge?tab=packages page. If your package is not no-arch but is a pure Python package, then you should probably update the feedstock to turn your package into a no-arch one.
• How do I know if my package is on emscripten-forge? You can see the list of packages pubished on emscripten-forge here. In case your package is missing, or it's not up-to-date, feel free to open an issue or a PR on https://github.com/emscripten-forge/recipes.

voici-demo's Issues

Update to `mamba-org/setup-micromamba@v1`

As noticed in https://github.com/voila-dashboards/voici-demo/actions/runs/7567527338?pr=20:

This action is deprecated and no longer maintained. Please use mamba-org/setup-micromamba instead. See https://github.com/mamba-org/provision-with-micromamba#migration-to-setup-micromamba for a migration guide.

So we should update this line:

voici-demo/.github/workflows/deploy.yml

Line 24 in 0af62ae

uses: mamba-org/provision-with-micromamba@main

Drop the JupyterLite `--contents` CLI option?

The build command now uses two ways for proving contents:

voici-demo/.github/workflows/deploy.yml

Line 31 in 0af62ae

run: voici build --contents content --output-dir dist --XeusAddon.mounts content:/content

From an outside perspective, it could confuse users who may not know what the differences between the two are.

Maybe we can simplify it with the following:

 run: voici build --output-dir dist --XeusAddon.mounts content:/content 

Kernel Missing

Hello guys, I'm working on GitLab, and I'm using your library to deploy the Jupyter Notebook on GL Pages. The Pipeline end in success, and everything seems fine, apart from the fact that when I try to launch the page, it is stuck at the "Running" phase.

It seemed to me that the Kernel was not starting, and indeed in the deploy pipeline I've found this row:
"""
{...}/python3.10/site-packages/jupyterlite_xeus/add_on.py: UserWarning: kernel binaries not found for xpython-raw
"""

And then again same thing:

"""
{...}/python3.10/site-packages/jupyterlite_xeus/add_on.py: UserWarning: kernel binaries not found for xpython
"""

So, my feeling is that apparently it is not recognizing the kernel. Any idea in how to solve this?

.gitlab-ci.yml?

I'd like to see the same deployment that happens on github (with the deploy.yml) also translated into a .gitlab-ci.yml, to apply the
same process also on GitLab and not only on GitHub. Is it in the roadmap? Does it already exist?