Créer votre application Streamlit¶

Cette rubrique décrit comment déployer une application Streamlit in Snowflake à partir d’un code d’application Streamlit existant. Si vous êtes novice en matière de Streamlit in Snowflake et voulez d’abord essayer une application de démarrage, consultez Premiers pas avec Streamlit in Snowflake.

Avant de commencer :

Assurez-vous de répondre aux conditions préalables requises.
Choisissez un environnement d’exécution pour votre application (conteneur ou entrepôt).
Préparez vos dépendances dans un fichier requirements.txt, pyproject.toml ou environment.yml.
Vérifiez l’organisation de fichiers prévue pour les fichiers sources de votre application.

Déployer votre code d’application¶

Si vous disposez déjà d’une application Streamlit sur votre machine locale ou sur une zone de préparation Snowflake, utilisez l’une des méthodes suivantes pour créer un objet STREAMLIT à partir de vos fichiers sources.

Connectez-vous à Snowsight.
Dans le menu de navigation, sélectionnez Projects » Streamlit.
Sélectionnez + Streamlit App.
Saisissez un nom pour votre application.
Dans la liste déroulante App location sélectionnez la base de données et le schéma de votre application.
Configurez l’environnement d’exécution de votre application :

Pour créer une application en environnement d’exécution de conteneurs, procédez comme suit :
- Sélectionnez Run on container.
- Sélectionnez un pool de calcul sur lequel exécuter votre application.
- Sélectionnez un entrepôt de requêtes sur lequel exécuter les requêtes de votre application.
Pour créer une application en environnement d’exécution d’entrepôt, procédez comme suit :
- Sélectionnez Run on warehouse.
- Sélectionnez un entrepôt sur lequel exécuter votre application.
Sélectionnez Create.
Dans l’éditeur, remplacez le code de départ par votre propre code d’application. Vous pouvez coller directement du code ou importer des fichiers :
- Pour importer des fichiers, sélectionnez + (Ajouter) » Upload file, choisissez les fichiers, puis sélectionnez Upload.
- Pour créer des fichiers supplémentaires (par exemple, pyproject.toml), sélectionnez + (Ajouter) » Create new file.
Sélectionnez Run.

Importez les fichiers de votre application vers une zone de préparation nommée :

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;

Vous pouvez également importer des fichiers via Snowsight comme décrit dans Mise des fichiers en zone de préparation à l’aide de Snowsight.

Créez l’objet STREAMLIT de vos fichiers en zone de préparation :

Pour créer une application en environnement d’exécution de conteneur, exécutez la commande suivante :

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;

Pour créer une application en environnement d’exécution d’entrepôt, omettez les paramètres RUNTIME_NAME et COMPUTE_POOL :

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

Publiez votre code sur la version en ligne :
```
ALTER STREAMLIT my_app ADD LIVE VERSION FROM LAST;
```
Vous devez exécuter cette commande avant que les utilisateurs ne disposant que du privilège USAGE sur l’objet Streamlit puissent le consulter.

Pour la référence complète des paramètres, consultez CREATE STREAMLIT.

Note

Snowflake CLI version 3.14.0 ou ultérieure est requise. La version 3.14+ utilise par défaut la syntaxe moderne CREATE STREAMLIT.

Dans votre répertoire de projet, créez un fichier snowflake.yml à côté du code de votre application.

Pour créer une application en environnement d’exécution de conteneur, utilisez la configuration suivante :

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

Pour créer une application en environnement d’exécution d’entrepôt, omettez compute_pool et 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

Listez tous les fichiers dont votre application a besoin dans la section artifacts.

Déployez l’application :
```
snow streamlit deploy --open
```

Pour plus d’informations, consultez les guides Créer une appli Streamlit et Déploiement d’une application Streamlit.

Visualiser une application Streamlit¶

Pour obtenir des informations sur les privilèges requis pour voir une application Streamlit, voir Privilèges requis pour visualiser une application Streamlit.

Connectez-vous à Snowsight.
Dans le menu de navigation, sélectionnez Projects » Streamlit.
Sélectionnez l’application Streamlit que vous souhaitez afficher.

si vous consultez une application Streamlit multi-pages, sélectionnez un onglet pour afficher des pages supplémentaires.

Pour afficher des informations sur un objet STREAMLIT :

DESC STREAMLIT my_app;

Pour afficher l’application dans un navigateur, connectez-vous à Snowsight, puis dans le menu de navigation, sélectionnez Projects » Streamlit, puis sélectionnez l’application.

Pour obtenir l’URL de votre application déployée :

snow streamlit get-url my_app

Configurer CI/CD avec GitHub Actions¶

Vous pouvez déployer des applications Streamlit in Snowflake automatiquement à partir d’un référentiel Git en utilisant Snowflake CLI et GitHub Actions. Vous pouvez utiliser une approche similaire avec d’autres fournisseurs CI/CD.

Conditions préalables¶

Un référentiel GitHub contenant les fichiers de votre application Streamlit et snowflake.yml.
Un secret SNOWCLI_PW configuré dans vos paramètres de référentiel GitHub.

Exemple de flux de travail¶

Créer un fichier .github/workflows/deploy.yml dans votre référentiel :

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

Validez et publiez le fichier pour déclencher le workflow.

Pour plus d’informations, consultez Documentation sur GitHub Actions.