Streamlitアプリの作成¶

このトピックでは、既存のStreamlitアプリのコードから|sis|アプリをデプロイする方法について説明します。|sis|の利用が初めてで、まずスターターアプリを試してみたい場合は、:doc:`/developer-guide/streamlit/getting-started/overview`を参照してください。

始める前に：

必要な:ref:`前提条件<label-streamlit_prereqs>`を満たしていることを確認します。
アプリの:doc:`ランタイム環境<runtime-environments>`（コンテナまたはウェアハウス）を選択します。
requirements.txt、pyproject.toml、または:file:`environment.yml`ファイルで:doc:`依存関係<dependency-management>`を準備します。
アプリのソースファイルについて想定される:doc:`ファイル構成<file-organization>`を確認します。

アプリコードのデプロイ¶

ローカルマシン上またはSnowflakeステージ上にすでにStreamlitアプリがある場合は、次のいずれかの方法を使用して、ソースファイルからSTREAMLITオブジェクトを作成します。

Snowsight にサインインします。
ナビゲーションメニューで Projects » Streamlit を選択します。
+ Streamlit App を選択します。
アプリの名前を入力します。
App location ドロップダウンで、アプリのデータベースとスキーマを選択します。
アプリのランタイムを構成します。

コンテナランタイムアプリを作成するには、以下のように選択します。
- Run on container を選択します。
- アプリを実行するコンピューティングプールを選択します。
- アプリのクエリを実行するクエリウェアハウスを選択します。
ウェアハウスランタイムアプリを作成するには、以下のように選択します。
- Run on warehouse を選択します。
- アプリを実行するウェアハウスを選択します。
Create を選択します。
エディターで、スターターコードを独自のアプリコードに置き換えます。コードを直接貼り付けるか、ファイルをアップロードできます。
- ファイルをアップロードするには、:ui:`+`（追加） » :ui:`Upload file`を選択し、ファイルを選んで:ui:`Upload`を選択します。
- 追加のファイル（:file:`pyproject.toml`など）を作成するには、:ui:`+`（追加） » :ui:`Create new file`を選択します。
Run を選択します。

アプリファイルを名前付きステージにアップロードします。
```
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;
```
:doc:`/user-guide/data-load-local-file-system-stage-ui`で説明されているように、|sf-web-interface|を使用してファイルをアップロードすることもできます。
ステージングされたファイルからSTREAMLITオブジェクトを作成します。

コンテナランタイムアプリを作成するには、次のコマンドを実行します。
```
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;
```
ウェアハウスランタイムアプリを作成するには、RUNTIME_NAMEおよびCOMPUTE_POOLパラメーターを省略します。
```
CREATE STREAMLIT my_app
   FROM '@my_db.my_schema.my_stage/app'
   MAIN_FILE = 'streamlit_app.py'
   QUERY_WAREHOUSE = my_warehouse;
```
コードをライブバージョンにプッシュします。
```
ALTER STREAMLIT my_app ADD LIVE VERSION FROM LAST;
```
StreamlitオブジェクトのUSAGE権限のみを持つユーザーに対して表示されるようにするには、このコマンドを実行する必要があります。

パラメーターの完全な参照情報については、:doc:`/sql-reference/sql/create-streamlit`を参照してください。

注釈

Snowflake CLI バージョン3.14.0以降が必要です。バージョン3.14以降は、デフォルトで最新の CREATESTREAMLIT 構文を使用します。

プロジェクトディレクトリで、アプリコードと同じ場所に:file:`snowflake.yml`ファイルを作成します。

コンテナランタイムアプリを作成するには、次の構成を使用します。

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

ウェアハウスランタイムアプリを作成するには、``compute_pool``および``runtime_name``を省略します。

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

アプリに必要なすべてのファイルを``artifacts``セクションにリストします。

アプリをデプロイします。
```
snow streamlit deploy --open
```

詳細については、/developer-guide/snowflake-cli/streamlit-apps/manage-apps/initialize-app`および:doc:/developer-guide/snowflake-cli/streamlit-apps/manage-apps/deploy-app`のガイドを参照してください。

Streamlitアプリを表示する¶

Streamlitアプリの表示に必要な権限については、 Streamlitアプリの表示に必要な権限を参照してください。

Snowsight にサインインします。
ナビゲーションメニューで Projects » Streamlit を選択します。
表示したいStreamlitアプリを選択します。

マルチページのStreamlitアプリを表示する場合は、タブを選択して追加ページを表示します。

STREAMLITオブジェクトに関する情報を表示するには、以下を実行します。

DESC STREAMLIT my_app;

ブラウザでアプリを表示するには、|sf-web-interface-link|にサインインし、ナビゲーションメニューで:ui:`Projects` |raa| :ui:`Streamlit`を選択して、アプリを選択します。

デプロイされたアプリのURLを取得するには、以下を実行します。

snow streamlit get-url my_app

GitHub Actionsを使用したCI/CDのセットアップ¶

|sf-cli|および`GitHub Actions<https://docs.github.com/en/actions>`_を使用して、Gitリポジトリから|sis|アプリを自動的にデプロイできます。他のCI/CDプロバイダーでも、同様のアプローチを使用できます。

前提条件¶

Streamlitアプリファイルと:file:`snowflake.yml`を含むGitHubリポジトリ。
GitHubリポジトリ設定で構成された``SNOWCLI_PW``シークレット。

ワークフロー例¶

リポジトリ内に:file:`.github/workflows/deploy.yml`ファイルを作成します。

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

ファイルをコミットおよびプッシュすると、ワークフローがトリガーされます。

詳細については、 GitHub Actions ドキュメンテーションをご参照ください。