Zum Inhalt springen

Eine Panel-App erstellen

Beginnen Sie mit Panel Studio. Es braucht kein Repository und keine Einrichtung: Sie erstellen die App in PlaidCloud, sehen sich eine Vorschau an und veröffentlichen sie, wenn Sie so weit sind. Wählen Sie eine individuelle Laufzeit nur, wenn Studio nicht passt.

Öffnen Sie Apps und öffnen Sie das Menü Neue App. Unter der Überschrift Panel-App schreibt und veröffentlicht Studio die App im Editor von PlaidCloud mit dem Standardlayout und bewahrt den Code für Sie auf. Sie können auch Neue Studio-App in der Zeile Studio-Apps der Karte Apps & Branding auf der Registerkarte Startseite eines Projekts wählen oder mit einer Tabelle beginnen.

  1. Wählen Sie Neue App > Studio.

  2. Geben Sie einen Namen ein. Der URL-Slug wird daraus ausgefüllt.

  3. Wählen Sie das Projekt, dem die App gehört. Sie benötigen Bearbeitungszugriff auf das Projekt.

  4. Wählen Sie unter Starten mit aus, womit die App beginnt:

    Starten mit Sie erhalten
    Leere App Eine minimale App mit einer app.py und einer requirements.txt.
    Aus einer Tabelle Eine App, die auf der ausgewählten Tabelle aufbaut.
    Aus einer Ansicht Dasselbe, aufgebaut auf einer Projektansicht.
    Aus einer anderen Studio-App Eine Kopie einer Ihrer Studio-Apps.
    Aus der Galerie Eine Kopie einer App, die Ihr Workspace in der Galerie aufgeführt hat.
  5. Wählen Sie Erstellen. Studio öffnet die neue App. Bei einer Tabelle oder einer Ansicht ist der Weave-Prompt zum Erstellen der ersten Seite zum Senden bereit.

Siehe Panel Studio, um die App zu bearbeiten, in der Vorschau anzusehen und zu veröffentlichen.

Sie können auch auf der Registerkarte Tabellen eines Projekts beginnen. Wählen Sie eine Tabelle oder Ansicht aus und wählen Sie dann Panel-App erstellen im Menü Neu oder im Kontextmenü. Das Dialogfeld Neue Studio-App öffnet sich mit dem bereits gewählten Projekt und der gewählten Tabelle. Der Befehl ist verfügbar, wenn Sie Bearbeitungszugriff auf das Projekt haben und das Projekt nicht schreibgeschützt ist.

Wählen Sie Neue App > Aus der Galerie…, um die Apps zu durchsuchen, die Ihr Workspace aufgelistet hat, und dann App daraus erstellen…, um Ihre eigene Kopie anzulegen. Oder wählen Sie Aus der Galerie im Dialogfeld Neue Studio-App. Siehe Die App-Galerie, einschließlich der Frage, wie Sie Ihre eigene App auflisten.

Studio-Apps decken die meisten Dashboards und Tools ab. Für individuelle Anforderungen veröffentlichen Sie mit einer der anderen Laufzeiten über das Menü Neue App:

  • Nur Browser – Ihr eigenes Repository; die App läuft im Browser des Betrachters.
  • Serverbasiert – Ihr eigenes Repository; die App läuft auf einem PlaidCloud-Server, zum Beispiel um vorhandenen Code oder Ihren eigenen Build-Prozess wiederzuverwenden.
  • Dash-App – veröffentlichen Sie eine Plotly-Dash-App. Siehe Dash-Apps.

Eine Server-App wird aus einem Git-Repository erstellt und unter https://<your-tenant-host>/serve/<slug>/ bereitgestellt. Sie verweisen PlaidCloud auf einen Branch eines Repositorys; es erstellt aus dem Code einen Container, führt darin panel serve aus und erstellt ihn automatisch neu, sobald Sie in diesen Branch pushen.

Ihr Repository braucht zwei Dinge: einen Einstiegspunkt – eine Python-Datei, die eine Panel-App erstellt und mit .servable() markiert – und optional eine requirements.txt, die zusätzliche Pakete auflistet, entweder im Stammverzeichnis des Repositorys oder neben Ihrem Einstiegspunkt.

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

Erstellen Sie app.py:

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

Das ist eine vollständige App. Der Aufruf .servable() ist das, was PlaidCloud bereitstellt – alles, was dargestellt werden soll, muss als servable markiert sein (direkt oder indem es in einem servable-Layout liegt).

Panel-Apps sind interaktiv. Diese hier fügt einen Schieberegler hinzu, der eine Tabelle live aktualisiert:

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()

Dieses zweite Beispiel importiert pandas, das nicht zum Basis-Image gehört. Fügen Sie daher eine requirements.txt hinzu (im Stammverzeichnis des Repositorys oder neben Ihrem Einstiegspunkt):

pandas

PlaidCloud installiert diese mit pip, wenn es das Image erstellt. Gängige Visualisierungsbibliotheken – plotly, holoviews, hvplot – gehören ebenfalls nicht zum Basis-Image, führen Sie daher hier alle auf, die Ihre App importiert.

Was die Plattform bereitstellt – und erwartet. Beachten Sie diese Annahmen, wenn Sie Ihre App schreiben:

  • panel und bokeh sind vorinstalliert durch das Basis-Image der Plattform. Führen Sie sie nicht in requirements.txt auf und vermeiden Sie das Festschreiben einer älteren Panel-Version – der Wiederverbindungsmechanismus für Live-Aktualisierungen setzt eine neuere voraus.
  • Die PlaidCloud-Clientbibliotheken (plaidcloud-rpc, plaidcloud-utilities) sind vorinstalliert. Importieren Sie plaidcloud.rpc oder plaidcloud.utilities direkt – führen Sie sie nicht in requirements.txt auf.
  • requirements.txt kann im Stammverzeichnis des Repositorys oder neben Ihrem Einstiegspunkt liegen. In einem gemeinsam genutzten Repository (Monorepo) halten Sie die Abhängigkeiten jeder App in ihrem eigenen Ordner. Eine Datei auf Stammebene wird, falls vorhanden, ebenfalls installiert – legen Sie gemeinsame Abhängigkeiten dort ab und App-spezifische neben der App.
  • Die App läuft als Nicht-Root-Benutzer auf einem schreibgeschützten Dateisystem. Nur /tmp ist beschreibbar, schreiben Sie temporäre Dateien daher dorthin (die meisten Bibliotheken beachten $TMPDIR bereits).
  • Codieren Sie Port, URL-Präfix oder Host nicht fest. PlaidCloud weist sie zu und fügt sie bei der Bereitstellung ein – rufen Sie einfach .servable() auf.

Um den PlaidCloud-Look und vorgefertigte Filter, Raster und Diagramme zu erhalten, erstellen Sie Ihre App mit dem Panel-App-Kit.

Das Design festlegen: Hell, Dunkel oder umschaltbar

Abschnitt betitelt „Das Design festlegen: Hell, Dunkel oder umschaltbar“

Server-Apps werden standardmäßig im modernen Fast-Design von PlaidCloud dargestellt – einem klaren, an Fluent angelehnten Look, der plattformweit angewendet wird. Im Veröffentlichungsdialog steuert Design diese Plattformebene:

  • FAST – der PlaidCloud-Standard. Verwenden Sie es für neue Apps und für Apps, die mit Fast-Vorlagen erstellt wurden.
  • Standard – das Standard-Styling von Panel. Verwenden Sie es, wenn das CSS oder die Darstellung einer vorhandenen App unter FAST nicht mehr funktioniert.

Was Sie in Ihrem App-Code steuern, ist das Theme: hell, dunkel oder ein Umschalter, den der Betrachter betätigen kann.

Das Theme ist eine Eigenschaft der Vorlage, die Sie bereitstellen. Die Fast-Vorlagen – FastListTemplate (eine einzelne Spalte) und FastGridTemplate (ein responsives Raster) – nehmen dafür zwei Einstellungen entgegen:

  • theme – "default" für hell oder "dark". Wenn Sie es setzen, wird die App auf dieses Theme festgelegt, auch wenn ein Betrachter ?theme=dark an die URL anhängt.
  • theme_toggle – True zeigt in der Kopfzeile einen Umschalter zwischen Hell und Dunkel; False blendet ihn aus. Standardmäßig ist es True. Das Ausblenden des Umschalters legt das Theme nicht von selbst fest – legen Sie es mit theme fest (siehe oben); setzen Sie danach theme_toggle=False, damit Betrachter keinen Umschalter sehen, der nichts ändern kann.

Wählen Sie das Muster, das zu Ihrer App passt.

Nur hell – am besten für dichte Berichte und Finanztabellen, die meist von Hand für einen hellen Hintergrund gestaltet sind:

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

Nur dunkel:

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

Den Betrachter wählen lassen – standardmäßig hell, mit einem Umschalter in der Kopfzeile. Lassen Sie theme weg, damit es dem Umschalter folgt:

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

Wenn Sie Dunkel zulassen, machen Sie Ihre Tabellen dunkelfähig. Ein Tabulator, das auf ein helles Tabellen-Theme (theme="bootstrap") festgelegt ist, oder benutzerdefiniertes CSS mit fest codierten hellen Farben wie background: #fff wird auf einer dunklen Seite als unleserlicher weißer Block dargestellt. Verwenden Sie ein Tabellen-Theme, das der App folgt – pn.widgets.Tabulator(..., theme="fast") – und vermeiden Sie fest codierte helle Farben. Wenn ein Bericht stark von Hand für Hell gestaltet ist, legen Sie ihn stattdessen auf Hell fest (das erste Muster oben).

Eine einfache App ohne Vorlage – pn.Column(...).servable() – folgt dem Panel-Standard und wird von diesen Einstellungen nicht beeinflusst; greifen Sie zu einer Vorlage, wenn Sie explizite Kontrolle wünschen.

Ihr Repository muss über eine Git-Verbindung in PlaidCloud erreichbar sein. Wenn Ihr Code in PlaidCloud Git liegt, erstellen Sie unter Tools > Connections eine verwaltete PlaidCloud Git-Verbindung – sie benötigt weder eine Server-URL noch Zugangsdaten. Den gesamten Weg von einem leeren Repository bis zu einer bereitgestellten App finden Sie unter Eine Panel-App aus PlaidCloud Git bereitstellen.

  1. Wählen Sie Neue App > Serverbasiert, um das Dialogfeld Server-Panel-App veröffentlichen zu öffnen. Seine Einstellungen sind in Abschnitte gegliedert.
  2. Unter Verzeichniseinstellungen:
    • App-Name – der Anzeigename, der in der Liste erscheint.
    • URL-Slug – sowohl die URL der App als auch ihr interner Name, daher muss er ein gültiges DNS-Label sein: Kleinbuchstaben, Ziffern und Bindestriche, beginnend mit einem Buchstaben, höchstens 40 Zeichen (zum Beispiel sales-dashboard). Das Dialogfeld prüft dies vor der Veröffentlichung.
    • Notiz – eine optionale Beschreibung.
    • Projekt – das Projekt, dem die App gehört. Es liefert das Branding der App und ist das Standardprojekt für ihre Tabellen. Sie können es hier nach der Veröffentlichung nicht mehr ändern; verwenden Sie Zuweisen.
  3. Unter Git-Verbindung und Veröffentlichungsüberwachung:
    • Git-Verbindung – die Verbindung, die das Repository Ihrer App enthält.
    • Branch – der Branch, aus dem erstellt wird. Pushes in diesen Branch erstellen die App automatisch neu und stellen sie erneut bereit.
    • Einstiegspunkt – die .py-Datei, die Panel bereitstellen soll (Ihre app.py).
  4. Unter Laufzeit:
    • CPU und Arbeitsspeicher, die der Container der App anfordern soll.

      Weniger Ressourcen (weniger CPU / Arbeitsspeicher) lassen die App schneller einplanen und kalt starten.

    • Design – wählen Sie FAST für das moderne Design von PlaidCloud oder Standard, wenn das CSS der App das Standard-Styling von Panel erwartet.

    • Leerlauf (Minuten) – wie lange die App ohne Datenverkehr warm bleibt, bevor sie auf null herunterskaliert wird. Der Standard sind 5 Minuten.

    • Öffentlichen Zugriff zulassen – aktivieren Sie das Kontrollkästchen, um unauthentifizierten Zugriff zu erlauben; andernfalls müssen sich Betrachter an Ihrem Mandanten anmelden.

  5. Unter Erweitert (eingebettete Bereitstellung) – optional. Standardmäßig wird die App nur von Ihrem PlaidCloud-Mandanten bereitgestellt. Um sie in eine andere Website einzubetten, klicken Sie auf Domäne hinzufügen und geben Sie jede Domäne ein, die sie laden darf, eine pro Zeile – nur ein Host, ohne Schema oder Pfad (zum Beispiel example.com oder app.example.com:8443). Lassen Sie die Liste leer, es sei denn, Sie betten die App anderswo ein.
  6. Klicken Sie auf Veröffentlichen.

Nach der Veröffentlichung wird die App erstellt – ihr Status wird in der Liste angezeigt und aktualisiert sich automatisch. Unter Eine Panel-App verwenden erfahren Sie, was die Status bedeuten, wie Sie die App öffnen, sobald sie bereit ist, und wie Sie eine Neuerstellung auslösen, ohne die Veröffentlichung aufzuheben.

Die URL der App funktioniert erst, wenn ihr Build-Status Bereit ist, und die erste Anfrage nach einer Leerlaufzeit startet sie und zeigt dabei kurz einen PlaidCloud-Ladebildschirm.

Technisch versierte Benutzer können die App mit denselben Eingaben erstellen und testen, die PlaidCloud verwendet. Das ist die engste lokale Prüfung vor dem Veröffentlichen oder dem Klick auf Neu erstellen.

PlaidCloud erstellt aus dem ausgewählten Git-Branch mit diesem generierten Dockerfile. Verwenden Sie lokal denselben Inhalt als 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

So bilden Sie den Server-Build nach:

  1. Checken Sie denselben Branch aus, den Sie unter Branch auswählen.
  2. Führen Sie den Build vom Stammverzeichnis des Repositorys aus, damit COPY . /app mit PlaidCloud übereinstimmt.
  3. Legen Sie optionale Abhängigkeiten in einer requirements.txt ab – im Stammverzeichnis des Repositorys oder neben Ihrem Einstiegspunkt. Beide werden installiert, die des App-Ordners zuletzt (damit eine app-spezifische Festlegung gewinnt).
  4. Verwenden Sie denselben Pfad zum Einstiegspunkt, den Sie unter Einstiegspunkt auswählen.
Terminal-Fenster
docker build \
-f Dockerfile.plaidcloud-panel \
-t local-panel-app:plaidcloud \
.

Das bereitgestellte Image überschreibt den Einstiegspunkt des Basis-Images nicht. Es führt panel serve anhand von Umgebungsvariablen aus, die PlaidCloud einfügt. Testen Sie das erstellte Image mit demselben Laufzeitvertrag:

Terminal-Fenster
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

Öffnen Sie http://localhost:5006/serve/local/.

Gleichen Sie beim Testen die Einstellungen des Veröffentlichungsdialogs ab:

  • Einstiegspunkt entspricht APP_PATH=/app/<entry-point>.
  • CPU und Arbeitsspeicher entsprechen den Docker-Grenzen --cpus und --memory.
  • Design: FAST entspricht PLAID_PANEL_DESIGN=fast.
  • Design: Standard bedeutet, PLAID_PANEL_DESIGN wegzulassen.
  • Leerlauf (Minuten) entspricht dem Zeitfenster für das Herunterskalieren in der Bereitstellung. Lokales Docker erzwingt es nicht, aber die App verwendet weiterhin dieselben Einstellungen für Panel-Websocket-Keepalive und Sitzungsbereinigung.
  • Domänen für Embedded Serving entsprechen PANEL_ORIGIN; verwenden Sie eine durch Leerzeichen getrennte Liste, wenn Sie mehr als einen Host testen müssen.

Wenn Sie keinen Container benötigen, können Sie die Serve-Schicht dennoch aus einer lokalen Python-Umgebung testen. Installieren Sie dieselbe requirements.txt, setzen Sie die Umgebungsvariablen der Plattform und führen Sie dann panel serve mit denselben Flags aus, die das bereitgestellte Image verwendet.

Terminal-Fenster
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)"

Öffnen Sie http://localhost:5006/serve/local/.

Verwenden Sie PLAID_PANEL_DESIGN=fast, um dem standardmäßig bereitgestellten Look zu entsprechen. Um die Option Standard für das Design im Veröffentlichungsdialog zu testen, lassen Sie PLAID_PANEL_DESIGN ungesetzt und führen Sie denselben Befehl aus. Behalten Sie PANEL_PREFIX, PANEL_ORIGIN, --keep-alive und --unused-session-lifetime bei; diese sind Teil des Laufzeitvertrags der Bereitstellung.

Eine WASM-App läuft im Browser aus einer vorab erstellten HTML-Datei.

  1. Wählen Sie Neue App > Nur Browser, um das Dialogfeld Serverlose Panel-App veröffentlichen zu öffnen.
  2. Geben Sie einen App-Namen und eine Version ein.
  3. Wählen Sie den HTML-Speicherort der App – die HTML-Datei in einem Dokumentenkonto.
  4. Geben Sie einen URL-Slug der App und optional eine Notiz ein.
  5. Klicken Sie auf Veröffentlichen. Eine WASM-App hat keinen Build-Schritt und wird sofort bereitgestellt.