JupyterLab integration

[fonsp]

Help welcome!

I managed to get this working for one setup, but I am not sure how to make it more general so that other people can install it.

The repository is here:

https://github.com/fonsp/pluto-on-binder

with a demo on binder:

https://mybinder.org/v2/gh/fonsp/pluto-on-binder/master
(it's one of the options when launching a new kernel/notebook)
or you can skip the Jupyter UI and go straight to Pluto:
https://mybinder.org/v2/gh/fonsp/pluto-on-binder/master?urlpath=pluto

I also got it running as jupyterlab extension with a nice button and logo

It sets up jupyter for binder with the http server proxy extension, and installs a mini python package that is used by Jupter as an extension, available through ?urlpath=pluto.

Goals

1. Instructions for other people who have JupyterHub/Lab (not sure which is which) running on how to add Pluto. Should plutoproxy be a registered Python package?
2. (down the road) Integrate JupyterLab-specific UI into Pluto, like the RAM usage, a button to go back to the Lab Hub menu thingy, Pluto notebooks as a tab within Lab, instead of a full-screen window, and what else?

[shashankp]

lungben#3 is to make Pluto work with Binder, which is essentially Jupyter.
Should work in local/binder/any other env

This works right now

docker run -it -p 8080:8080 plutojl/pluto-binder:latest jupyter notebook --ip=0.0.0.0 --port=8080

[fonsp]

We can run Pluto notebooks as Lab tabs:
https://jupyter-server-proxy.readthedocs.io/en/latest/server-process.html

Also set a very high HTTP timeout (60 works)

[fonsp]

@koehlerson wrote this handy guide!

https://www.maximiliankoehler.de/posts/pluto-server/

[koehlerson]

let me know if you need the post without the teaching stuff overhead somewhere

[fonsp]

Could someone take a look at: https://github.com/illumidesk/jupyter-pluto-proxy Which Pluto version does it use? Will it be stuck on an outdated version? @jgwerner

It's listed in the official jupyter server proxy docs: https://jupyter-server-proxy.readthedocs.io/en/latest/examples.html

[koehlerson]

The repo itself or the binder? Binder used 12.4. when I tried. I think it will work ootb as long as these lines don't change for starting a Pluto.jl Server https://github.com/IllumiDesk/jupyter-pluto-proxy/blob/main/jupyter_pluto_proxy/__init__.py#L23

[jgwerner]

HI @fonsp ! First of all kudos for developing Pluto, 💯 We can update Pluto in this example repo no problem, should we just update Pluto to the latest stable release? We could also add a bot to automatically create a PR to update the version when you cut a new release. In our case, the use-case was to set up a POC since our tool uses the JupyterHub and some folks are more on the Julia side of things than Python.

@koehlerson regarding the default command, we can update that too.

As far as the perceived official status goes, we sometimes send a PR to the jupyter-server-proxy repo and/or add jupyter-server-proxy as a repo topic. Both of these were recommendations from @betatim from this thread. To avoid duplicating "official" repos, we would gladly transfer what we did to your GH account/org and help contribute to the repo in your account.

[fonsp]

@koehlerson @barche @jgwerner @GiggleLiu You have all managed to run Pluto on JupyterLab, that's great! @koehlerson even wrote a detailed guide: https://www.maximiliankoehler.de/posts/pluto-server/

Let's work together to create a simple and clear way for people to install Pluto as an extension.

I think @koehlerson has done most of the work already, but still left is:

• It should not use a pluto-on-binder repository -- this is confusing for me (what am I maintaining?) and for others. It looks like some people have installed fonsp/pluto-on-binder as a lab extension instead of barche/pluto-on-binder. I have made a new repository https://github.com/fonsp/pluto-on-jupyterlab where you all have write access, let's make this the place to house:
  • a README (redirecting to @koehlerson 's blog) and
  • all files needed for the extension
• Make sure that it works with the most recent version of Pluto
• How will people update Pluto after they have installed the extension? (pip update?) This needs to be documented clearly
• Add link to instructions to fonsp/Pluto.jl/wiki, add redirect and warning to fonsp/pluto-on-binder/README.md

And then we can close this issue!

[fonsp]

FYI, the differences between pluto-on-binder and pluto-on-jupyterlab are:

• pluto-on-binder has all security disabled, and will have a modified HTTP proxy that is even less secure to allow unauthenticated CORS
• pluto-on-binder does not have a logo
• At some point, pluto-on-binder will just be a single Dockerfile to optimize the launch times even further
• At some point, pluto-on-jupyterlab might have UI specific for jupyterlab, like a button to go back to the lab menu (feel free to make more suggestions!)

[koehlerson]

Hey Fons,
this sounds good. I pushed the setup I use on my server, which should work for the current version of Pluto.jl as well. However, I cannot confirm and I have a lot of deadlines this week. Maybe @GiggleLiu can try it? Sorry again @GiggleLiu for the wrong pip plugin link in the tutorial. I'll fix all links and commands as soon as the new repo is good to go for reproduction.

Feel free to remove the .toml and .yml files/file. I wasn't sure if they are leftovers from the fork or if they are actually needed. IMHO they can be removed, but I'm not confident enough to guarantee it.

If you are interested in the interaction of WGLMakie and such a Pluto.jl server, I can also describe in a short tutorial how admins can set this up.