Repolode
timkpaine

timkpaine/jupyterlab-iframe

WebサイトやローカルのHTMLファイルをiframeウィジェットで開き、ランチャーにクイックリンクを追加できるJupyterLab拡張機能。

スター
118
フォーク
22
未解決の Issue
4
最終コミット
6 日前

これは何?

jupyterlab_iframeを使うと、JupyterLabを離れることなく、埋め込みiframeパネル内でWebページやローカルのHTMLファイルを表示できます。サイトはJupyterの設定ファイルでリストとして定義し、それぞれのパスにはhttpまたはhttpsのURL、あるいはディスク上のHTMLファイルを指すlocal://パスを指定できます。

設定したサイトは、JupyterLabの初回起動時に自動で開くようにできるため、ランディングページに適しています。また、ランチャーにタイルを追加することもできます。ランチャーのタイルには、指定があればカスタムアイコンURLが使われ、なければサイトのfaviconが使われます。デフォルトではlocal://スキームを使って任意のローカルファイルを開けますが、allow_any_localをFalseに設定すると、明示的に登録したサイトだけにアクセスを制限できます。

このプロジェクトはpipでインストールし、labextensionとserver extensionとして有効化します。Binderの環境で、ノートブック環境の起動時にランディングページを表示する用途にも使われています。

主な機能

  • 01JupyterLabのiframeウィジェット内にWebページやローカルのHTMLファイルを埋め込み表示できます。
  • 02サイトをリストで設定し、自動起動やランチャーへの追加を指定できます。
  • 03ランチャーのカスタムアイコンに対応し、未指定の場合はサイトのfaviconを使用します。
  • 04ローカルファイルへのアクセスを、明示的に登録したサイトだけに制限できます。

ユースケース

  • プロジェクトのダッシュボードやドキュメントをノートブックと並べて表示する。
  • Binder環境の起動時にランディングページや手順を表示する。
  • JupyterLab内からローカルのHTMLレポートや可視化を開く。

クイックスタート

  1. 1

    Python パッケージをインストールする

    pip install jupyterlab_iframe
  2. 2

    JupyterLab 拡張機能をインストールする

    jupyter labextension install jupyterlab_iframe
  3. 3

    サーバー拡張機能を有効にする

    jupyter serverextension enable --py jupyterlab_iframe
  4. 4

    サイト一覧を jupyter_notebook_config.py に追加する

使う前に知っておきたいこと

  • デフォルトでは、allow_any_local を False に設定しない限り、ファイルシステム上の任意のローカルファイルを local:// スキームで開けます。
  • README のインストール手順では古い labextension コマンドと serverextension コマンドが使われているため、現在の JupyterLab のバージョンでは動作しない場合があります。

トピック

よくある質問

jupyterlab-iframe とは?
WebサイトやローカルのHTMLファイルをiframeウィジェットで開き、ランチャーにクイックリンクを追加できるJupyterLab拡張機能。 jupyterlab_iframeを使うと、JupyterLabを離れることなく、埋め込みiframeパネル内でWebページやローカルのHTMLファイルを表示できます。サイトはJupyterの設定ファイルでリストとして定義し、それぞれのパスにはhttpまたはhttpsのURL、あるいはディスク上のHTMLファイルを指すlocal://パスを指定できます。
jupyterlab-iframe は無料で使えますか?ライセンスは?
jupyterlab-iframe は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
jupyterlab-iframe は今もメンテナンスされていますか?
活発にメンテナンス中。jupyterlab-iframe の最終コミットは 2026年11月2日 です。
jupyterlab-iframe は何に使えますか?
プロジェクトのダッシュボードやドキュメントをノートブックと並べて表示する。 Binder環境の起動時にランディングページや手順を表示する。 JupyterLab内からローカルのHTMLレポートや可視化を開く。
jupyterlab-iframe のインストール方法は?
Python パッケージをインストールする: pip install jupyterlab_iframe JupyterLab 拡張機能をインストールする: jupyter labextension install jupyterlab_iframe サーバー拡張機能を有効にする: jupyter serverextension enable --py jupyterlab_iframe サイト一覧を jupyter_notebook_config.py に追加する
jupyterlab-iframe はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/timkpaine/jupyterlab-iframe

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト