Ce guide détaille les étapes nécessaires pour configurer et exécuter localement le site web de documentation NiceGUI sur un système Windows. Ceci est particulièrement utile si l'accès direct aux ressources en ligne est lent ou indisponible, ou pour le développement hors ligne.

1. Préparation de l'environnement de travail

Comemncez par créer un dossier dédié sur votre système. Par exemple, nommez-le nicegui_docs_locale.

mkdir nicegui_docs_locale
cd nicegui_docs_locale

2. Acquisition du code source NiceGUI

Téléchargez le dépôt NiceGUI dans votre répertoire de travail. Pour des raisons de performance sur certaines régions, il peut être préférable d'utiliser une source miroir comme Gitee si GitHub est lent.

git clone https://gitee.com/mirrors/nicegui.git

Cela créera un sous-répertoire nicegui contenant le code source complet.

3. Configuration de l'environnement virtuel Python

Il est recommandé d'utiliser un environnement virtuel pour gérer les dépendances spécifiques à ce projet. Créez un nouvel environnement virtuel, par exemple nommé env_docs.

python -m venv env_docs

Après la création, activez l'environnement virtuel.

.\env_docs\Scripts\activate.bat

Note sur les politiques d'exécution PowerShell : Si vous utilisez PowerShell et rencontrez l'erreur "L'exécution de scripts est désactivée sur ce système", vous devrez ajuster la politique d'exécution. Ouvrez PowerShell en tant qu'administrateur et exécutez :

Set-ExecutionPolicy RemoteSigned

Confirmez en tapant Y lorsque vous y êtes invité.

4. Structure des fichiers essentiels

Pour faire fonctionner le site de documentation, seuls quelques fichiers et dossiers spécifiques sont nécessaires à partir du dépôt NiceGUI cloné. Créez un répertoire src dans votre environnement virtuel (ou à côté si vous préférez une séparation plus nette) et copiez-y les éléments suivants depuis le dossier nicegui que vous avez cloné :

• Le répertoire website
• Le fichier main.py
• Le fichier prometheus.py

Votre structure de répertoire devrait ressembler à ceci (en supposant que src est à la racine de votre environnement virtuel):

nicegui_docs_locale/
├── nicegui/ (le dépôt cloné)
└── env_docs/
    ├── Scripts/
    ├── Lib/
    ├── ...
    └── src/
        ├── website/ (copié depuis nicegui/website)
        ├── main.py (copié depuis nicegui/main.py)
        └── prometheus.py (copié depuis nicegui/prometheus.py)

5. Installation des dépendancse Python

Le site de documentation NiceGUI s'appuie sur plusieurs bibliothèques Python. Nous allons les installer une par une en identifiant celles qui manquent. Avant de commencer, assurez-vous que votre outil pip est à jour :

python -m pip install --upgrade pip

Maintenant, tentez d'exécuter main.py. Il est probable que des erreurs de type ModuleNotFoundError apparaissent, indiquant les dépendances manquantes. Installez-les au fur et à mesure :

Exécution et installation pas à pas :

python env_docs/src/main.py

Si vous voyez une erreur concernant fastapi :

ModuleNotFoundError: No module named 'fastapi'

Installez-le :

pip install fastapi

Ensuite, une erreur concernant itsdangerous pourrait apparaître :

ModuleNotFoundError: No module named 'itsdangerous'

Installez-le :

pip install itsdangerous

Puis, l'erreur nicegui elle-même :

ModuleNotFoundError: No module named 'nicegui'

Installez NiceGUI :

pip install nicegui

Enfin, une dépendance spécifique à la documentation, isort, pourrait manquer :

ModuleNotFoundError: No module named 'isort'

Installez isort :

pip install isort

Après avoir installé toutes ces dépendances, tentez de nouveau d'exécuter main.py. Si tout est correct, vous devriez voir un message dans le terminal indiquant que l'application NiceGUI est démarrée, généralement avec une adresse URL (par exemple, http://localhost:8080).

6. Création d'un script de démarrage simplifié

Pour faciliter le lancement futur du site de documentation, vous pouvez créer un petit script batch. Dans le répertoire racine nicegui_docs_locale (ou un emplacement similaire), créez un fichier nommé lancer_docs.bat avec le contenu suivant :

@echo off
REM Active l'environnement virtuel
call .\env_docs\Scripts\activate.bat
REM Lance l'application NiceGUI
python .\env_docs\src\main.py
REM Maintient la fenêtre ouverte après l'exécution
pause

Désormais, un double-clic sur ce fichier lancer_docs.bat activera l'environnement virtuel et démarrera le serveur de documentation NiceGUI, rendant le contenu accessible via votre navigateur web.