コンテンツにスキップ

Panelアプリの作成

まずPanel Studioから始めてください。リポジトリもセットアップも不要で、PlaidCloudでアプリを構築し、プレビューして、準備ができたら公開できます。独自のランタイムを選択するのは、Studioが適さない場合のみにしてください。

アプリを開き、新規アプリメニューを開きます。Panel アプリの見出しの下にあるStudioは、標準レイアウトでPlaidCloudのエディターにアプリを書き込んで公開し、コードを保持します。プロジェクトのホームタブのアプリとブランディングカードのStudio アプリ行で新規 Studio アプリを選択するか、テーブルから開始することもできます。

  1. 新規アプリ > Studioを選択します。

  2. 名前を入力します。URLスラッグは、そこから自動的に入力されます。

  3. アプリを所有するプロジェクトを選択します。プロジェクトの編集アクセス権が必要です。

  4. 開始元で、アプリの開始元を選択します。

    開始元 作成されるもの
    空のアプリ app.pyとrequirements.txtを持つ最小限のアプリ。
    テーブルから 選択したテーブルに基づいて構築されたアプリ。
    ビューから 同様に、プロジェクトのビューに基づいて構築されたもの。
    別の Studio アプリから 自分のStudioアプリのコピー。
    ギャラリーから ワークスペースがギャラリーに掲載したアプリのコピー。
  5. 作成を選択します。Studioが新しいアプリを開きます。テーブルまたはビューの場合は、最初のページを構築するためのWeaveのプロンプトが送信できる状態になっています。

アプリの編集、プレビュー、公開については、Panel Studioを参照してください。

プロジェクトのテーブルタブから開始することもできます。1つのテーブルまたはビューを選択し、新規メニューまたは右クリックメニューからPanel アプリを作成を選択します。プロジェクトとテーブルがすでに選択された状態で、新しい Studio アプリダイアログが開きます。このコマンドは、プロジェクトの編集アクセス権があり、プロジェクトが読み取り専用でない場合に使用できます。

新規アプリ > ギャラリーから… メニュー項目を選択して、ワークスペースが掲載したアプリを閲覧し、これからアプリを作成… ボタンを選択して、自分用のコピーを作成します。または、新しい Studio アプリダイアログでギャラリーからを選択します。自分のアプリを掲載する方法を含め、アプリギャラリーを参照してください。

Studioアプリは、ほとんどのダッシュボードとツールに対応します。独自の要件がある場合は、新規アプリメニューから、他のランタイムのいずれかで公開します。

  • ブラウザのみ — 自分のリポジトリです。アプリは、閲覧者のブラウザーで実行されます。
  • サーバーベース — 自分のリポジトリです。アプリはPlaidCloudのサーバーで実行されます。たとえば、既存のコードや独自のビルドプロセスを再利用する場合です。
  • Dash アプリ — Plotly Dashアプリを公開します。Dashアプリを参照してください。

サーバーアプリは、gitリポジトリから構築され、https://<your-tenant-host>/serve/<slug>/で提供されます。リポジトリのブランチをPlaidCloudに指定すると、コードがコンテナーにビルドされ、そこでpanel serveが実行され、そのブランチにプッシュするたびに自動的に再ビルドされます。

アプリのリポジトリを準備する

Section titled “アプリのリポジトリを準備する”

リポジトリには、2つのものが必要です。エントリポイント(Panelアプリを構築し、.servable()でマークするPythonファイル)と、必要に応じて、追加のパッケージを一覧にした requirements.txt です。このファイルは、リポジトリのルート、またはエントリポイントの隣に配置します。

my-panel-app/
├── app.py # entry point — calls .servable()
└── requirements.txt # optional; extra dependencies (repo root or next to app.py)

app.pyを作成します。

import panel as pn
pn.extension()
pn.pane.Markdown("# Hello, PlaidCloud 👋\n\nYour first server-side Panel app is running.").servable()

これで完全なアプリです。PlaidCloudが提供するのは.servable()の呼び出しです。表示したいものはすべて、(直接、またはservableなレイアウトの内側で)servableとしてマークする必要があります。

Panelアプリはインタラクティブです。この例では、テーブルをリアルタイムで更新するスライダーを追加します。

import pandas as pd
import panel as pn
pn.extension()
multiplier = pn.widgets.IntSlider(name="Multiplier", start=1, end=10, value=3)
@pn.depends(multiplier)
def times_table(m):
df = pd.DataFrame({"n": range(1, 6)})
df["result"] = df["n"] * m
return pn.pane.DataFrame(df, index=False)
pn.Column(
"# Times Table",
multiplier,
times_table,
).servable()

この2つ目の例では、ベースイメージに含まれていないpandasをインポートしているため、requirements.txt(リポジトリのルート、またはエントリポイントの隣)を追加します。

pandas

PlaidCloudは、イメージのビルド時に、これらをpipでインストールします。plotly、holoviews、hvplotなどの一般的な可視化ライブラリも、ベースイメージには含まれていないため、アプリがインポートするものはここに記載してください。

プラットフォームが提供するもの、そして想定しているもの。アプリを作成するときは、次の前提を念頭に置いてください。

  • panelとbokehは、プラットフォームのベースイメージにプリインストールされています。requirements.txtに記載せず、古いPanelバージョンのピン留めも避けてください。ライブ更新の再接続は、新しいバージョンに依存しています。
  • PlaidCloudのクライアントライブラリ(plaidcloud-rpc、plaidcloud-utilities)はプリインストールされています。plaidcloud.rpcまたはplaidcloud.utilitiesを直接インポートし、requirements.txtには記載しないでください。
  • requirements.txtは、リポジトリのルート、またはエントリポイントの隣に配置できます。共有(モノレポ)リポジトリでは、各アプリの依存関係をそれぞれのフォルダーに置いてください。ルートレベルのファイルがある場合は、それもインストールされます。共有の依存関係はそこに、アプリ固有のものはアプリの隣に置きます。
  • アプリは、読み取り専用のファイルシステム上で、非rootユーザーとして実行されます。書き込めるのは/tmpのみのため、一時ファイルはそこに書き込んでください(ほとんどのライブラリは、すでに$TMPDIRに従います)。
  • ポート、URLプレフィックス、ホストをハードコードしないでください。PlaidCloudがこれらを割り当て、デプロイ時に注入します。.servable()を呼び出すだけです。

PlaidCloudの外観と、すぐに使えるフィルター、グリッド、チャートを利用するには、Panelアプリキットでアプリを構築してください。

テーマの設定:ライト、ダーク、または切り替え

Section titled “テーマの設定:ライト、ダーク、または切り替え”

サーバーアプリは、デフォルトで、PlaidCloudのモダンなFastデザインで表示されます。これは、プラットフォーム全体に適用される、Fluent風のすっきりした外観です。公開ダイアログでは、デザインがこのプラットフォーム層を制御します。

  • FAST — PlaidCloudのデフォルトです。新しいアプリと、Fastテンプレートで構築されたアプリに使用します。
  • デフォルト — Panelのデフォルトのスタイルです。既存アプリのCSSや外観がFASTで崩れる場合に使用します。

アプリのコードで制御するのは、テーマ(ライト、ダーク、または閲覧者が切り替えられるスイッチ)です。

テーマは、提供するテンプレートのプロパティです。Fastテンプレート(FastListTemplate(単一の列)とFastGridTemplate(レスポンシブなグリッド))には、そのための2つの設定があります。

  • theme — ライトの場合は"default"、ダークの場合は"dark"です。設定すると、閲覧者がURLに?theme=darkを追加しても、アプリがそのテーマに固定されます。
  • theme_toggle — Trueはヘッダーにライト/ダークの切り替えスイッチを表示し、Falseは非表示にします。デフォルトはTrueです。スイッチを非表示にしても、テーマが固定されるわけではありません。上記のthemeで固定してください。固定した後は、何も変更できないスイッチが閲覧者に表示されないよう、theme_toggle=Falseを設定します。

アプリに合ったパターンを選択してください。

ライトのみ — 通常、ライトの背景向けに手作業でスタイルが設定される、密度の高いレポートや財務テーブルに最適です。

import panel as pn
pn.extension("tabulator")
pn.template.FastListTemplate(
title="Sales Dashboard",
theme="default", # light
theme_toggle=False, # hide the switch
main=[...],
).servable()

ダークのみ:

pn.template.FastListTemplate(
title="Ops Monitor",
theme="dark",
theme_toggle=False,
main=[...],
).servable()

閲覧者に選択させる — デフォルトはライトで、ヘッダーにスイッチがあります。themeを省略して、切り替えに従うようにします。

pn.template.FastListTemplate(
title="Explorer",
theme_toggle=True,
main=[...],
).servable()

ダークを許可する場合は、テーブルもダークに対応させてください。ライトのテーブルテーマ(theme="bootstrap")に固定されたTabulatorや、background: #fffのようにライトの色をハードコードしたカスタムCSSは、ダークのページでは読み取れない白いブロックとして表示されます。アプリに追従するテーブルテーマ(pn.widgets.Tabulator(..., theme="fast"))を使用し、ライトの色のハードコードは避けてください。レポートがライト向けに大幅に手作業でスタイル設定されている場合は、代わりにライトに固定してください(上記の最初のパターン)。

テンプレートのないシンプルなアプリ(pn.Column(...).servable())は、Panelのデフォルトに従い、これらの設定の影響を受けません。明示的に制御したい場合は、テンプレートを使用してください。

リポジトリには、PlaidCloudのgit接続を通じてアクセスできる必要があります。コードがPlaidCloud Gitにある場合は、Tools > Connectionsで、管理対象のPlaidCloud Git接続を作成します。サーバーのURLも認証情報も不要です。空のリポジトリから、提供されるアプリまでの一連の流れについては、PlaidCloud GitからのPanelアプリのデプロイを参照してください。

  1. 新規アプリ > サーバーベースを選択して、サーバーPanelアプリを公開ダイアログを開きます。設定はセクションごとにグループ化されています。
  2. ディレクトリ設定で:
    • アプリ名 — リストに表示される表示名です。
    • URLスラッグ — アプリのURLと内部名の両方になるため、有効なDNSラベルである必要があります。小文字、数字、ハイフンのみで、文字で始まり、40文字以内にします(たとえば、sales-dashboard)。ダイアログは、公開前にこれを確認します。
    • メモ — 任意の説明です。
    • プロジェクト — アプリを所有するプロジェクトです。アプリのブランディングを提供し、そのテーブルのデフォルトのプロジェクトになります。公開後にここで変更することはできません。Assignを使用してください。
  3. Git接続と公開ウォッチャーで:
    • Git接続 — アプリのリポジトリを保持する接続です。
    • ブランチ — ビルド元のブランチです。このブランチにプッシュすると、アプリが自動的に再ビルドされ、再デプロイされます。
    • エントリポイント — Panelが提供する.pyファイル(app.py)です。
  4. ランタイムで:
    • アプリのコンテナーが要求するCPUとメモリ。

      リソース(CPU/メモリ)を少なくすると、アプリのスケジュールとコールドスタートが速くなります。

    • デザイン — PlaidCloudのモダンなデザインにはFASTを、アプリのCSSがPanelのデフォルトのスタイルを前提としている場合はデフォルトを選択します。

    • アイドル (分) — トラフィックがない状態で、アプリがウォームのまま維持され、その後ゼロにスケールバックするまでの時間です。デフォルトは5分です。

    • パブリックアクセスを許可 — チェックすると、認証なしのアクセスが許可されます。チェックしない場合、閲覧者はテナントにサインインする必要があります。

  5. 詳細 (埋め込み配信)(任意)。デフォルトでは、アプリはPlaidCloudのテナントからのみ提供されます。別のサイトに埋め込むには、ドメインを追加をクリックし、読み込みを許可する各ドメインを、1行に1つ入力します。ホストのみで、スキームやパスは含めません(たとえば、example.comやapp.example.com:8443)。アプリを他の場所に埋め込む場合を除き、リストは空のままにしてください。
  6. 公開をクリックします。

公開すると、アプリはビルドされます。ステータスはリストに表示され、自動的に更新されます。ステータスの意味、準備ができたアプリの開き方、公開を取り消さずに再ビルドを実行する方法については、Panelアプリの使い方を参照してください。

アプリのURLは、ビルドのステータスが準備完了になって初めて機能します。アイドル状態の後の最初のリクエストでは、起動し、その間はPlaidCloudの短い読み込み画面が表示されます。

詳細:PlaidCloudをローカルで再現する

Section titled “詳細:PlaidCloudをローカルで再現する”

技術に詳しいユーザーは、PlaidCloudが使用するのと同じ入力で、アプリをビルドしてテストできます。これは、公開前、または再ビルドをクリックする前にできる、最も近いローカルでの確認です。

PlaidCloudは、選択したgitブランチから、この生成されたDockerfileでビルドします。ローカルでも、同じ内容をDockerfile.plaidcloud-panelとして使用してください。

FROM us-docker.pkg.dev/plaidcloud-build/panel-base/platform-panel-base:0.5.1
USER root
COPY . /app
RUN if [ -f /app/requirements.txt ]; then pip install --no-cache-dir -r /app/requirements.txt; fi
# If your entry point is in a subfolder, PlaidCloud also installs that folder's requirements.txt,
# after the root one (so a per-app pin wins). Replace <app-folder> with your entry point's folder,
# or drop this line if your app is at the repository root.
RUN if [ -f "/app/<app-folder>/requirements.txt" ]; then pip install --no-cache-dir -r "/app/<app-folder>/requirements.txt"; fi
USER 10001

サーバーのビルドと一致させるには:

  1. ブランチで選択したものと同じブランチをチェックアウトします。
  2. COPY . /appがPlaidCloudと一致するように、リポジトリのルートからビルドを実行します。
  3. 任意の依存関係は、リポジトリのルート、またはエントリポイントの隣にあるrequirements.txtに記述します。どちらもインストールされ、アプリのフォルダーのものが最後にインストールされます(アプリごとのピン留めが優先されます)。
  4. エントリポイントで選択したものと同じエントリポイントのパスを使用します。
ターミナルウィンドウ
docker build \
-f Dockerfile.plaidcloud-panel \
-t local-panel-app:plaidcloud \
.

デプロイされるイメージは、ベースイメージのエントリポイントを上書きしません。PlaidCloudが注入する環境変数からpanel serveを実行します。ビルドしたイメージを、同じランタイムの契約でテストします。

ターミナルウィンドウ
docker run --rm \
--cpus 0.5 \
--memory 512m \
-p 5006:5006 \
-e APP_PATH=/app/app.py \
-e PANEL_PREFIX=/serve/local \
-e PANEL_PORT=5006 \
-e PANEL_ORIGIN=localhost:5006 \
-e PANEL_KEEP_ALIVE_MS=25000 \
-e PLAID_PANEL_DESIGN=fast \
local-panel-app:plaidcloud

http://localhost:5006/serve/local/を開きます。

テスト時には、公開ダイアログの設定と一致させます。

  • エントリポイントは、APP_PATH=/app/<entry-point>に対応します。
  • CPUとメモリは、Dockerの--cpusと--memoryの制限に対応します。
  • デザイン:FASTは、PLAID_PANEL_DESIGN=fastに対応します。
  • デザイン:デフォルトは、PLAID_PANEL_DESIGNを省略することを意味します。
  • アイドル (分) は、デプロイ時のスケールダウンの猶予時間に対応します。ローカルのDockerでは適用されませんが、アプリは、同じPanelのWebSocketキープアライブとセッションクリーンアップの設定を使用します。
  • 埋め込み配信のドメインは、PANEL_ORIGINに対応します。複数のホストをテストする必要がある場合は、スペース区切りのリストを使用します。

コンテナーが不要な場合でも、ローカルのPython環境から、配信レイヤーをテストできます。同じrequirements.txtをインストールし、プラットフォームの環境変数を設定してから、デプロイされるイメージと同じフラグでpanel serveを実行します。

ターミナルウィンドウ
export APP_PATH=app.py
export PANEL_PREFIX=/serve/local
export PANEL_PORT=5006
export PANEL_ORIGIN=localhost:5006
export PANEL_KEEP_ALIVE_MS=25000
export PLAID_PANEL_DESIGN=fast
panel serve "$APP_PATH" \
--address 0.0.0.0 \
--port "$PANEL_PORT" \
--prefix "$PANEL_PREFIX" \
--allow-websocket-origin "$PANEL_ORIGIN" \
--num-procs 1 \
--keep-alive "$PANEL_KEEP_ALIVE_MS" \
--unused-session-lifetime 15000 \
--index "$(basename "$APP_PATH" .py)"

http://localhost:5006/serve/local/を開きます。

デプロイされた外観のデフォルトに合わせるには、PLAID_PANEL_DESIGN=fastを使用します。公開ダイアログのデフォルトデザインのオプションをテストするには、PLAID_PANEL_DESIGNを設定せずに、同じコマンドを実行します。PANEL_PREFIX、PANEL_ORIGIN、--keep-alive、--unused-session-lifetimeはそのままにしてください。これらは、デプロイされるランタイムの契約の一部です。

WASMアプリは、事前にビルドされたHTMLファイルから、ブラウザーで実行されます。

  1. 新規アプリ > ブラウザのみを選択して、サーバーレスPanelアプリを公開ダイアログを開きます。
  2. アプリ名とバージョンを入力します。
  3. アプリHTMLの場所(ドキュメントアカウント内のHTMLファイル)を選択します。
  4. アプリURLスラッグと、任意のメモを入力します。
  5. 公開をクリックします。WASMアプリにはビルドのステップがなく、すぐに提供されます。