Embed Bokeh app in Jupyter server extension

pepijndevos · January 20, 2022, 11:59am

Jupyter server extensions are basically Tornado handlers, but looking at the tornado embedding example it looks like that actually embeds Tornado handlers in a Bokeh Tornado Application.

Is there a way to embed a Bokeh app as a Tornado handler rather than a whole Application? Or what would be the best way to integrate the two?

I don’t want to run Bokeh in a notebook, I want to deploy it as a full fledged application with access to JupyterLab.

https://jupyter-server.readthedocs.io/en/latest/developers/extensions.html#authoring-a-configurable-extension-application

github.com

bokeh/bokeh/blob/branch-3.0/examples/howto/server_embed/tornado_embed.py

from jinja2 import Environment, FileSystemLoader
from tornado.web import RequestHandler

from bokeh.embed import server_document
from bokeh.layouts import column
from bokeh.models import ColumnDataSource, Slider
from bokeh.plotting import figure
from bokeh.sampledata.sea_surface_temperature import sea_surface_temperature
from bokeh.server.server import Server
from bokeh.themes import Theme

env = Environment(loader=FileSystemLoader('templates'))

class IndexHandler(RequestHandler):
    def get(self):
        template = env.get_template('embed.html')
        script = server_document('http://localhost:5006/bkapp')
        self.write(template.render(script=script, template="Tornado"))

def bkapp(doc):

This file has been truncated. show original

pepijndevos · January 20, 2022, 2:34pm

For now I’ve ended up doing something more like the Flask integration, except sharing the Tornado IOLoop. Both servers are running on different ports, and then server_document just connects to the Bokeh server. It works quite nicely once you set allow_websocket_origin.

Bryan · January 20, 2022, 6:06pm

Jupyter app extensions looks interesting but AFAIK no one has ever looked into it. It’s definitely not something that will fit into my own bandwidth envelope any time soon, so if you already have some expertise, I’d encourage you to try to look into it (I’m happy to answer any technical questions). As you have noted a Bokeh server is basically just a collection of handlers that need to be installed on an IOLoop somehow.

system · April 20, 2022, 6:07pm

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.