jhub apps

JupyterHub アプリ ランチャー

JupyterHub Apps Launcher は、汎用的なサーバー ランチャーです。このプロジェクトの目標は、ユーザーが指定したコマンドを介して、Flask サーバー、FastAPI サーバー、パネル ダッシュボードなどの起動をサポートすることです。現在、次のフレームワークがサポートされています。

• パネル
• ボケ味
• ストリームライト
• プロットリーダッシュ
• 出来上がり
• グラディオ
• ジュピターラボ
• 一般的な Python コマンド

インストール

 pip install jhub-apps

またはconda経由

conda install -c conda-forge jhub-apps

開発インストール

依存関係のインストール

conda env create -f environment-dev.yml
conda activate jhub-apps-dev
pip install -e .

React UI フロントエンドを開発するには、以下も実行します。

 cd ui
npm install
cd -

JupyterHub の起動

次の環境変数を設定します。

 export JHUB_APP_JWT_SECRET_KEY= $( openssl rand -hex 32 )

JupyterHub を起動します。

jupyterhub -f jupyterhub_config.py

次に、http://127.0.0.1:8000/hub/home に移動して、JHub Apps Launcher にアクセスします。

APIエンドポイント

Hub サービスは、FastAPI エンドポイント経由で公開されます。同じドキュメントについては、http://127.0.0.1:10202/services/japps/docs からアクセスできます。

認証されたエンドポイントを試すには、上記の URL の右上にある [承認] ボタンをクリックし、 OAuth2AuthorizationCodeBearer選択して [承認] をクリックします。

ローカルでの開発

注: ローカルで開発するには、JupyterHub バックエンドと React UI フロントエンドの両方が実行されている必要があります。

1. JupyterHub バックエンドを開始するには、ターミナルで次のコマンドを実行します。

jupyterhub -f jupyterhub_config.py

2. React UI フロントエンドを開始するには、 uiディレクトリから別のターミナルで次のコマンドを実行します。

npm run watch

テストの実行

単体テスト

pytest jhub_apps/tests

E2E テスト

pytest jhub_apps/tests/tests_e2e -vvv -s --headed

使用法

JHub Apps は、 SimpleLocalProcessSpawnerを使用するローカル JupyterHub とSystemdSpawnerを使用する The Littlest JupyterHub でテストされています。

• JHub アプリをインストールする

 pip install git + https : // github . com / nebari - dev / jhub - apps . git

• The Littlest JupyterHub のjupyterhub_config.pyに以下を追加します

 from tljh . user_creating_spawner import UserCreatingSpawner
from jhub_apps . configuration import install_jhub_apps

c . JupyterHub . bind_url = "<YOUR_JUPYTERHUB_URL>"
c . SystemdSpawner . unit_name_template = 'jupyter-{USERNAME}{JHUBSERVERNAME}'
c . JAppsConfig . apps_auth_type = "oauth" # or none (if you don't want authentication on apps)
c . JAppsConfig . python_exec = "python3"
# Pass in the path to jupyterhub config
c . JAppsConfig . jupyterhub_config_path = "jupyterhub_config.py"
# Either a static list of conda environments to show in the
# create panel apps form or a callable to fetch conda enviornments
# dynamically, e.g. from conda-store API
c . JAppsConfig . conda_envs = []
c = install_jhub_apps ( c , UserCreatingSpawner )