Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/timkpaine/jupyterlab_iframe

View html as an embedded iframe in JupyterLab
https://github.com/timkpaine/jupyterlab_iframe

jlab jupyter jupyterlab jupyterlab-extension

Last synced: about 2 months ago
JSON representation

View html as an embedded iframe in JupyterLab

Lists

README 

        
# jupyterlab_iframe



Open a site in a widget, or add a set of "quicklinks".



[![Build Status](https://github.com/timkpaine/jupyterlab_iframe/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/timkpaine/jupyterlab_iframe/actions?query=workflow%3A%22Build+Status%22)

[![codecov](https://codecov.io/gh/timkpaine/jupyterlab_iframe/branch/main/graph/badge.svg)](https://codecov.io/gh/timkpaine/jupyterlab_iframe)

[![PyPI](https://img.shields.io/pypi/l/jupyterlab_iframe.svg)](https://pypi.python.org/pypi/jupyterlab_iframe)

[![PyPI](https://img.shields.io/pypi/v/jupyterlab_iframe.svg)](https://pypi.python.org/pypi/jupyterlab_iframe)

[![npm](https://img.shields.io/npm/v/jupyterlab_iframe.svg)](https://www.npmjs.com/package/jupyterlab_iframe)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/timkpaine/jupyterlab_iframe/main?urlpath=lab)



![](https://raw.githubusercontent.com/timkpaine/jupyterlab_iframe/main/docs/example1.gif)



## Install



```bash

pip install jupyterlab_iframe

jupyter labextension install jupyterlab_iframe

jupyter serverextension enable --py jupyterlab_iframe

```



## Options



### External Sites



install the server extension, and add the following to `jupyter_notebook_config.py`



```python3

c.JupyterLabIFrame.iframes = ['list', 'of', 'sites']

```



In this example, `list`, `of`, and `sites` will be available as links in the command palette.



### Landing page on initial page load



```python3

c.JupyterLabIFrame.iframes = ['list', 'of', 'sites']

c.JupyterLabIFrame.welcome = 'a site to show on initial load'

c.JupyterLabIFrame.local_files = ['list', 'of', 'local', 'html', 'files']

```



In this example, `a site` will open by default the first time JupyterLab is opened.



### Open local html file in iframe



```python3

c.JupyterLabIFrame.local_files = ['list', 'of', 'local', 'html', 'files']

```



Any files specified by 'local_files' will be served up as local links. By default any file on the filesystem is allowed, to disable this and only allow the list specifically designated here, set `c.JupyterLabIFrame.allow_any_local = False`. If you allow all, in the open dialog start the file path with `local://`.



## Caveats



### Update for version v0.0.12 - Most of these are covered by [#31](https://github.com/timkpaine/jupyterlab_iframe/issues/31)



~~This package uses iframes, so is subject to a few restrictions:~~

~~- If Jlab is served over SSL, so must the sites (http/https must match)~~

~~- If the underlying site enforces same-origin, then we cannot navigate to them (e.g. google)~~



## Similar Packages



- [Jupyterlab-html](https://github.com/mflevine/jupyterlab_html) displays local html files as websites in an iframe

- [Jupyterlab-sandbox](https://github.com/canavandl/jupyterlab_sandbox)

- [Main JLab Issue](https://github.com/jupyterlab/jupyterlab/issues/2369)



## Configuring Binder with a landing page



To configure binder to serve a landing page, simply add the following configuration:



To requirements.txt:



`jupyterlab_iframe>=0.2`



To postBuild:



```bash

jupyter labextension install jupyterlab_iframe@^0.2

jupyter serverextension enable --py jupyterlab_iframe



config="c.JupyterLabIFrame.welcome = 'local://binder/landing.html'"

mkdir -p ~/.jupyter

echo -e $config > ~/.jupyter/jupyter_notebook_config.py

```