Streamlit en un double-clique

#14 Guide pratique pour transformer ton app Streamlit en app de bureau rendant le partage de ton application accessible, sans barrières techniques

May 28, 2024

Amazon Studios GIF by Amazon Prime Video

Voici un guide pratique pour t’aider à convertir ton application Streamlit en un fichier exécutable (.exe) que tu pourras partager avec tes collègues sans qu’ils aient besoin d'installer Python ou des dépendances supplémentaires.

Le but est d’arriver à ceci:

Tu cliques sur l’icon et l’application se lance!

Etape 1 : Préparation de l'environnement

Commence par créer un dossier pour organiser le projet. Dans cet exemple, on l’appelle streamlit2exe. Ce dossier contient tout le nécessaire pour transformer l’application Streamlit en un fichier exécutable. Ce dossier contient 3 éléments :

Dossier de l'application (mon_app) : Ce sous-dossier contient ton script Python principal et tous les autres scripts nécessaires au fonctionnement de ton application Streamlit (ici le script __init__.py est un script vide).
Fichier des Dépendances (requirements.txt) : Ce fichier texte liste toutes les bibliothèques Python que ton application nécessite pour fonctionner correctement.

Configuration du Projet (package.json) : Ce fichier JSON est crucial car il définit la structure et les commandes pour construire l’application via Electron. Voici un exemple de contenu pour ce fichier :

{
  "name": "mon_app",
  "version": "0.1.0",
  "main": "./build/electron/main.js",
  "scripts": {
    "dump": "dump-stlite-desktop-artifacts",
    "serve": "NODE_ENV=\"production\" electron .",
    "servewindows": "electron .",
    "pack": "electron-builder --dir",
    "dist": "electron-builder",
    "postinstall": "electron-builder install-app-deps"
  },
  "build": {
    "files": ["build/**/*"],
    "win": {
      "target": ["portable"]
    },
    "portable": {
      "artifactName": "mon_app.exe"
    },
    "directories": {
      "buildResources": "assets"
    }
  },
  "devDependencies": {
    "@stlite/desktop-cli": "^0.34.0",
    "@stlite/desktop": "^0.54.0",
    "cross-env": "^7.0.3",
    "electron": "^30.0.1",
    "electron-builder": "^24.13.3"
  }
}

Etape 2: Installation des Dépendances Node.js

Ouvre Git Bash (ton terminal) dans le dossier streamlit2exe (afin d’être déjà dans streamlit2exe) et exécute la commande suivante pour installer les dépendances nécessaires :

npm install

Cette commande configure l'environnement Node.js de ton projet et prépare le terrain pour la création de l'exécutable.

Étape 3: Création de l'exécutable

Après l'installation des packages Node.js, il est temps de préparer l'exécutable de ton application Streamlit. Utilise cette commande pour intégrer tes dépendances Python et préparer l'application :

npm run dump mon_app -- -r requirements.txt

Cette étape crée un dossier build avec tous les composants nécessaires de ton application.

Etape 4: Empaquetage et test

Lance la commande suivante pour empaqueter ton application dans un fichier exécutable :

npm run dist

Cette opération génère un fichier .exe dans le dossier dist, permettant à ton application Streamlit de s'exécuter sur n'importe quelle machine Windows par un simple double-clic, sans installations supplémentaires.

Tu trouveras l’icone dans le dossier dist

Étape 5: Partage et Support

Pour partager ton application, envoie simplement le fichier .exe à tes collègues. Si des questions ou des problèmes surgissent, des ressources comme la vidéo explicative de Fanilo Andrianasolo et divers forums en ligne peuvent fournir de l'aide supplémentaire :

Ce guide a pour but de simplifier le processus de transformation de ton application Streamlit en un fichier exécutable, rendant le partage de ton projet plus accessibles, sans barrières techniques.

A la semaine prochaine :)

Data Workers

Discussion about this post