Erstellen der Streamlit-App¶

Unter diesem Thema wird beschrieben, wie Sie eine Streamlit in Snowflake-App aus bestehendem Streamlit-App-Code bereitstellen. Wenn Sie neu bei Streamlit in Snowflake sind und zuerst eine Starter-App ausprobieren möchten, finden Sie Informationen hierzu unter Erste Schritte mit Streamlit in Snowflake.

Bevor Sie beginnen:

Stellen Sie sicher, dass Sie die erforderlichen Voraussetzungen.
Wählen Sie eine :doc:` Laufzeitumgebung <runtime-environments>` für Ihre App (Container oder Warehouse) aus.
Bereiten Sie Ihre Abhängigkeiten in einer:file:requirements.txt-, pyproject.toml oder environment.yml-Datei vor.
Überprüfen Sie die erwarteten Dateiorganisation für die Quelldateien Ihrer App.

Bereitstellen des App-Codes¶

Wenn Sie bereits eine Streamlit-App auf Ihrem lokalen Computer oder in einem Snowflake-Stagingbereich haben, verwenden Sie eine der folgenden Methoden, um ein STREAMLIT-Objekt aus Ihren Quelldateien zu erstellen.

Melden Sie sich bei Snowsight an.
Wählen Sie im Navigationsmenü die Option Projects » Streamlit aus.
Wählen Sie + Streamlit App aus.
Geben Sie einen Namen für Ihre App ein.
Wählen Sie in der Dropdown-Liste App location die Datenbank und das Schema für Ihre App aus.
Konfigurieren Sie die Laufzeitumgebung für Ihre App:

Um eine Container-Laufzeit-App zu erstellen, treffen Sie die folgende Auswahl:
- Wählen Sie Run on container aus.
- Wählen Sie einen Computepool aus, in dem Sie Ihre App ausführen möchten.
- Wählen Sie ein Abfrage-Warehouse aus, in dem Sie die Abfragen Ihrer App ausführen möchten.
Um eine Warehouse-Laufzeit-App zu erstellen, wählen Sie Folgendes aus:
- Wählen Sie Run on warehouse aus.
- Wählen Sie ein Warehouse aus, auf dem Sie Ihre App ausführen möchten.
Wählen Sie Create aus.
Ersetzen Sie im Editor den Startcode durch Ihren eigenen App-Code. Sie können Code direkt einfügen oder Dateien hochladen:
- Um Dateien hochzuladen, wählen Sie + (Hinzufügen) » Upload file und dann Upload aus.
- Um zusätzliche Dateien zu erstellen (z. B.:file:pyproject.toml), wählen Sie + (Hinzufügen) » Create new file aus.
Wählen Sie Run aus.

Laden Sie Ihre App-Dateien in einen benannten Stagingbereich hoch:

CREATE STAGE IF NOT EXISTS my_db.my_schema.my_stage;

PUT file:///path/to/streamlit_app.py @my_db.my_schema.my_stage/app
   AUTO_COMPRESS = FALSE OVERWRITE = TRUE;
PUT file:///path/to/pyproject.toml @my_db.my_schema.my_stage/app
   AUTO_COMPRESS = FALSE OVERWRITE = TRUE;

Sie können Dateien auch über Snowsight hochladen, wie in Bereitstellen von Dateien im Stagingbereich mit Snowsight beschrieben.

Erstellen Sie das STREAMLIT-Objekt aus Ihren Stagingdateien:

Um eine Container-Laufzeit-App zu erstellen, führen Sie den folgenden Befehl aus:

CREATE STREAMLIT my_app
   FROM '@my_db.my_schema.my_stage/app'
   MAIN_FILE = 'streamlit_app.py'
   RUNTIME_NAME = 'SYSTEM$ST_CONTAINER_RUNTIME_PY3_11'
   COMPUTE_POOL = my_compute_pool
   QUERY_WAREHOUSE = my_warehouse;

Um eine Warehouse-Laufzeit-App zu erstellen, lassen Sie die Parameter RUNTIME_NAME und COMPUTE_POOL weg:

CREATE STREAMLIT my_app
   FROM '@my_db.my_schema.my_stage/app'
   MAIN_FILE = 'streamlit_app.py'
   QUERY_WAREHOUSE = my_warehouse;

Übertragen Sie Ihren Code auf die Live-Version:
```
ALTER STREAMLIT my_app ADD LIVE VERSION FROM LAST;
```
Sie müssen diesen Befehl ausführen, bevor Benutzende mit ausschließlich der USAGE-Berechtigung für das Streamlit-Objekt es anzeigen können.

Die vollständige Parameterreferenz finden Sie unter CREATE STREAMLIT.

Bemerkung

Snowflake-CLI Version 3.14.0 oder höher ist erforderlich. Version 3.14+ verwendet die moderne CREATE STREAMLIT-Syntax standardmäßig.

Erstellen Sie in Ihrem Projektverzeichnis neben Ihrem App-Code eine snowflake.yml-Datei.

Um eine Container-Laufzeit-App zu erstellen, verwenden Sie die folgende Konfiguration:

definition_version: 2
entities:
   my_streamlit:
      type: streamlit
      identifier: my_app
      query_warehouse: my_warehouse
      compute_pool: my_compute_pool
      runtime_name: SYSTEM$ST_CONTAINER_RUNTIME_PY3_11
      main_file: streamlit_app.py
      artifacts:
      - streamlit_app.py
      - pyproject.toml

Um eine Warehouse-Laufzeit-App zu erstellen, lassen Sie compute_pool und runtime_name weg:

definition_version: 2
entities:
   my_streamlit:
      type: streamlit
      identifier: my_app
      query_warehouse: my_warehouse
      main_file: streamlit_app.py
      artifacts:
      - streamlit_app.py
      - environment.yml

Listen Sie alle von Ihrer App benötigten Dateien im Abschnitt artifacts auf.

Stellen Sie die App bereit:
```
snow streamlit deploy --open
```

Weitere Informationen dazu finden Sie in den Leitfäden zum Erstellen einer Streamlit-App und zum Bereitstellen einer Streamlit-App.

Anzeigen einer Streamlit-App¶

Informationen zu den Berechtigungen, die zum Anzeigen einer Streamlit-App erforderlich sind, finden Sie unter Erforderliche Berechtigungen zum Anzeigen einer Streamlit-App.

Melden Sie sich bei Snowsight an.
Wählen Sie im Navigationsmenü die Option Projects » Streamlit aus.
Wählen Sie die Streamlit-App aus, die Sie anzeigen möchten.

Wenn Sie eine mehrseitige Streamlit-App anzeigen, wählen Sie eine Registerkarte, um weitere Seiten anzuzeigen.

Anzeigen von Informationen zu einem STREAMLIT-Objekt:

DESC STREAMLIT my_app;

Um die App in einem Browser anzuzeigen, melden Sie sich bei Snowsight an, wählen Sie dann im Navigationsmenü Projects » Streamlit und schließlich die App aus.

Abrufen der URL für Ihre bereitgestellte App:

snow streamlit get-url my_app

Einrichten von CI/CD mitGitHub Actions¶

Sie können Streamlit in Snowflake-Apps automatisch aus einem Git-Repository mit Snowflake CLI und GitHub Actions bereitstellen. Sie können einen ähnlichen Ansatz mit anderen CI/CD-Anbietern verwenden.

Voraussetzungen¶

Ein GitHub-Repository, das Ihre Streamlit-App-Dateien und snowflake.yml enthält.
Ein SNOWCLI_PW-Geheimnis, das in den Einstellungen Ihres GitHub-Repositorys konfiguriert ist.

Beispiel-Workflow¶

Erstellen Sie eine .github/workflows/deploy.yml-Datei in Ihrem Repository:

name: Deploy via Snowflake CLI

on:
  push:
    branches:
      - main

env:
  PYTHON_VERSION: '3.12'

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    environment: dev
    steps:
      - name: 'Checkout GitHub Action'
        uses: actions/checkout@v3

      - name: Install Python
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}

      - name: 'Install Snowflake CLI'
        shell: bash
        run: |
          python -m pip install --upgrade pip
          pip install snowflake-cli

      - name: 'Create config'
        shell: bash
        env:
          SNOWFLAKE_PASSWORD: ${{ secrets.SNOWCLI_PW }}
        run: |
          mkdir -p ~/.snowflake
          cp config.toml ~/.snowflake/config.toml
          echo "password = \"$SNOWFLAKE_PASSWORD\"" >> ~/.snowflake/config.toml
          chmod 0600 ~/.snowflake/config.toml

      - name: 'Deploy the Streamlit app'
        shell: bash
        run: |
          snow streamlit deploy --replace

Committen und verschieben Sie die Datei, um den Workflow zu triggern.

Weitere Informationen finden Sie in der GitHub Dokumentation zu Aktionen.