Fix/readme

.gitignore

@@ -10,3 +10,8 @@ __pycache__/
 *.exe
 
 .idea
+
+config.json
+/PDF-Summariser/config.json
+**/config.json
+

PDF-Summariser/config.json

@@ -9,11 +9,6 @@
       "api_key": "ollama",
       "model": "phi4-mini",
       "base_url": "http://localhost:11434/v1"
-    },
-    {
-      "api_key": "AIzaSyDl59DHeAiS07Z6g9tn-avjH_gxtsInhJg",
-      "model": "gemini-2.5-flash",
-      "base_url": "https://generativelanguage.googleapis.com/v1beta/openai/"
     }
   ]
 }

README.fr.md

@@ -1,128 +1,213 @@
 # PDF Summariser 🤖📖
 
+# [README in english just here !](README.md)
+
+## Description
 
-## Description  
 **PDF Summariser** a pour objectif de résumer des fichiers PDF. L'application permet d'insérer des fichiers PDF, qui seront résumés en un maximum de 1400 mots, selon le choix de l'utilisateur. En outre, elle offre la possibilité de traduire les résumés en français, anglais ou allemand.
 
+Le résumé généré peut être enregistré au format **doc** ou **txt**.
+L’application inclut également un chatbot capable de répondre aux questions concernant le fichier PDF fourni ainsi que son résumé.
+
+### [Installation du projet pour le développement](#installation-du-projet-pour-le-développement)
+
 ---
 
 ## Application
 
-- **Téléchargez l'installeur** (Installer_PDF_Summariser.exe) et installer l'application pour la tester.
+- **Téléchargez l'installeur** [ici depuis le lien Google Drive](https://drive.google.com/file/d/1BBQ5qoO_sjPhNBxgeVlztx5BLySdJlAA/view?usp=sharing) et installer l'application pour la tester.
 
 ---
 
-## Fonctionnalités :  
-- **Résumé des fichiers PDF** : Résume  les fichiers PDF en fonction des préférences de l'utilisateur (jusqu’à 1400 mots maximum).  
-- **Traduction multilingue** : Traduction des résumés en français, anglais ou allemand.  
-- **Stockage des modèles IA** : Les modèles IA sont stockés au format JSON dans l'application.  
-- **Thèmes** : L'application peut être dans un thème clair ou sombre.  
+## Fonctionnalités :
 
----
+- **Résumé des fichiers PDF** : Résume les fichiers PDF en fonction des préférences de l'utilisateur (jusqu’à 1400 mots maximum).
+- **Traduction multilingue** : Traduction des résumés en français, anglais ou allemand.
+- **Chatbot intégré** : Permet de poser des questions sur le contenu du PDF et son résumé, pour une exploration interactive de la documentation.
+- **Export des résumés** : Enregistrement des résumés au format DOC (Word) ou TXT pour une conservation ou un partage facile.
+- **Stockage des modèles IA** : Les modèles IA sont stockés et configurés au format JSON dans l'application, permettant l'utilisation de plusieurs fournisseurs (OpenAI, Google Gemini, Ollama, etc.).
+- **Thèmes clairs et sombres** : L'interface propose un mode clair ou sombre, personnalisable pour un confort visuel optimal.
+- **Interface intuitive** : Conçue avec Tkinter et ttkbootstrap pour une expérience utilisateur simple et agréable.
+- **Installation facile** : Distribuée via un installeur Windows (.exe) créé avec InstallForge.
+- **Téléchargement automatique du modèle Ollama** : si un modèle Ollama local est sélectionné, l'application télécharge et installe automatiquement le modèle requis.
 
 # Demo
 
-![Demo d'un résumé en français](Demo/PDF-Summariser-demo.gif)
+![Demo d'un résumé en français](doc/demo/resume-fr.gif)
 
 Démo d'un résumé en français
 
-![Demo d'un résumé en anglais](Demo/PDF-Summariser-demo-ollama.gif)
+![Demo d'un résumé en anglais](doc/demo/resume-en.gif)
 
 Démo d'un résumé en anglais
 
-![Demo d'un résumé en allemand](Demo/PDF-Summariser-demo-deutsch.gif)
+![Demo d'un résumé en allemand](/doc/archives/Demo/PDF-Summariser-demo-deutsch.gif)
+
+Démo d'un résumé en allemand (avec la version 1.0 de PDF Summerasier)
+
+![Demo du chatbot de résumé](/doc/demo/sumbot-fr.gif)
 
-Démo d'un résumé en allemand
+Démonstration du chatbot répondant aux questions basées sur le résumé du PDF.  
+Le bot facilite l'exploration interactive du document en répondant aux questions de l'utilisateur.
 
-![Thème clair/sombre](Demo/PDF-Summariser-demo-themes.gif)
+![Enregistrer un résumé en format txt](/doc/demo/enregistrer-txt.gif)
+
+Enregistrer un résumé en format txt
+
+![Enregistrer un résumé en format doc](/doc/demo/enregistrer-doc.gif)
+
+Enregistrer un résumé en format doc
+
+![Thème clair/sombre](doc/demo/themes.gif)
 
 Démonstration thème clair/sombre
 
 ---
 
-## Apprentissage :  
-Ce projet m’a permis d’approfondir mes connaissances sur différents aspects :  
+## Apprentissage :
+
+Ce projet m’a permis d’approfondir mes connaissances sur différents aspects :
+
 1. **Manipulation des modèles IA** : J'ai appris à manipuler des modèles IA pour réaliser des tâches précises.
-2. **Manipulation des fichiers en Python** : Exploration et gestion des fichiers PDF, avec compréhension approfondie des données.  
-3. **Stockage et gestion des données** : Utilisation de formats JSON pour stocker et manipuler les données.  
-4. **Interface utilisateur avec Tkinter** : Création d’une interface graphique conviviale avec **Tkinter** et **Ttkbootstrap**.  
-5. **Programmation orientée objet (POO)** : Utilisation de la POO pour structurer le code de manière plus modulaire et extensible.  
-6. **Installeur d’application** : Utilisation de **InstallForge** pour faciliter le déploiement. 
+2. **Manipulation des fichiers en Python** : Exploration et gestion des fichiers PDF, avec compréhension approfondie des données.
+3. **Stockage et gestion des données** : Utilisation de formats JSON pour stocker et manipuler les données.
+4. **Interface utilisateur avec Tkinter** : Création d’une interface graphique conviviale avec **Tkinter** et **Ttkbootstrap**.
+5. **Programmation orientée objet (POO)** : Utilisation de la POO pour structurer le code de manière plus modulaire et extensible.
+6. **Installeur d’application** : Utilisation de **InstallForge** pour faciliter le déploiement.
 
 **L’objectif principal** était d’accroître mes connaissances sur les modèles IA, leurs différentes marques et modèles (benchmark) et d'être capable de les manipuler afin de réaliser des tâches précises.
 
 ---
 
 ## Utilisation
 
-### Ollama 
-#### A noter :  
-Pour l'utilisation du modèle Llama 3.2, il faut avoir téléchargé **Ollama** en local, sinon le modèle ne fonctionnera pas.  
+### Ollama
+
+#### A noter :
+
+Pour l'utilisation du modèle Llama 3.2, il faut avoir téléchargé **Ollama** en local, sinon le modèle ne fonctionnera pas.
 
-- **API KEY** : `ollama` (doit être rempli, mais n’est pas utilisé directement dans le code)  
-- **Nom du modèle** : `llama3.2` (par exemple)  
+- **API KEY** : `ollama` (doit être rempli, mais n’est pas utilisé directement dans le code)
+- **Nom du modèle** : `llama3.2` (par exemple)
 - **Base URL** : `http://localhost:11434/v1`
 
 ---
 
-### Google :  
-Vous pouvez utiliser une clé **Gemini** gratuite, disponible sur [https://ai.google.dev/](https://ai.google.dev/).  
-- **API KEY** : votre clé API  
-- **Nom du modèle**  : `gemini-1.5-flash` (par exemple)  
+### Google :
+
+Vous pouvez utiliser une clé **Gemini** gratuite, disponible sur [https://ai.google.dev/](https://ai.google.dev/).
+
+- **API KEY** : votre clé API
+- **Nom du modèle** : `gemini-1.5-flash` (par exemple)
 - **Base URL** : `https://generativelanguage.googleapis.com/v1beta/openai/`
 
 **Note** : Il est préférable d'utiliser le modèle `gemini-1.5-flash` plutôt que le modèle `gemini-1.5-flash-8b`, car ce dernier rencontre des difficultés à traduire les textes.
 
 ---
 
-### OpenAI :  
+### OpenAI :
+
 Il faut obtenir une clé sur [https://platform.openai.com/api-keys](https://platform.openai.com/api-keys).
-- **API KEY** : votre clé API  
-- **Nom du modèle** : `gpt-4o-mini` (par exemple)  
-- **Base URL** : laisser vide  
+
+- **API KEY** : votre clé API
+- **Nom du modèle** : `gpt-4o-mini` (par exemple)
+- **Base URL** : laisser vide
 
 ---
 
-### Autres modèles IA :  
+### Autres modèles IA :
+
 Vous pouvez également insérer d'autres modèles IA, mais il est nécessaire de consulter leur documentation officielle pour savoir comment configurer leurs API clés et bases URL.
 
 ---
 
-## Problèmes rencontrés :  
-- Les changements de langue ne fonctionnent parfois pas correctement selon le modèle IA choisi.
-- Certains modèles d'IA peuvent rencontrer des difficultés à traduire les textes. 
-- Si vous utilisez les modèles Ollama en local, le temps de chargement peut varier, notamment en fonction du processeur que vous utilisez.
+# Installation du projet pour le développement
+
+## 1. Créer et activer un environnement virtuel
+
+```bash
+python -m venv .venv
+```
+
+Après, activez l'environement virtuel
+
+Sur Windows :
+
+```bash
+python -m venv .venv
+.\.venv\Scripts\activate
+```
+
+Sur Linux :
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+## 2. Installer les dépendances Python
+
+```bash
+pip install -r requirements.txt
+```
+
+## 3. Installer les outils externes
+
+Le projet nécessite trois outils externes :
+
+- **Ollama**
+- **Poppler**
+- **Tesseract-OCR**
+
+Vous avez deux possibilités :
+
+1. **Les installer directement sur votre PC** (méthode classique)
+2. **OU** les placer **dans les dossiers du projet**, comme dans la version installée (.exe),  
+   et suivre les instructions fournies dans chaque README dédié.
+
+Ainsi, si vous installez les outils sur votre machine, il n'y a **rien d'autre à faire**.  
+Si vous préférez les inclure dans le projet, vous devez suivre les instructions fournies dans les répertoires correspondants.
 
 ---
 
-## Ce qui pourrait être amélioré :  
-- **Interface de gestion des modèles IA** : Une fenêtre permettant de voir et de configurer tous les modèles IA et leurs paramètres.  
-- Résolution du bogue mentionné précédemment.  
-- **Conservation des résumés** : Permettre de stocker les résumés pour un accès facile à l’avenir.  
-- **Prise en charge OCR pour les fichiers PDF** : La bibliothèque actuelle ne supporte pas les PDF scannés.  
-- Ajouter la possibilité pour la lecture des fichiers **Word** et **OCR**.
-- Ajouter une interface graphique en anglais et en allemand
-- Ajouter une requête **asynchrone** pour afficher le résumé de manière incrémentale, de sorte qu'une partie du texte soit affichée avant même que le résumé ne soit terminé, ce qui permet à l'utilisateur de commencer à lire sans attendre.
-- Ajouter un tuto pour l'utilisateur.
+### Installer Ollama
+
+Téléchargement :  
+https://ollama.com/
+
+Instructions pour l’installer **dans le projet** :  
+[PDF-Summariser/Ollama/README.fr.md](/PDF-Summariser/Ollama/README.fr.md)
 
 ---
 
-## A noter :
-Au début, le code était en procédural et le modèle était stocké dans un .env, car je ne savais pas trop où j’allais et je testais. Ensuite, j’ai décidé de passer à une approche orientée objet lorsque j’ai vu que j’allais un peu plus loin. Cela permet d’avoir un code plus modulable et extensible. Je pourrais par exemple facilement ajouter des fonctionnalités supplémentaires. D’ailleurs, je ne pense pas modifier le code prochainement, mais si je le fais, j’envisage à l’avenir d’ajouter des fonctionnalités telles que la lecture de fichiers Word et la prise en charge de PDF OCR. J’aimerais également rajouter quelques fenêtres supplémentaires ainsi que quelques contrôles utilisateur.
+### Installer Poppler
+
+Téléchargement :  
+https://github.com/oschwartz10612/poppler-windows/releases
+
+Instructions pour l’installer **dans le projet** :  
+[PDF-Summariser/poppler-24.08.0/README.fr.md](/PDF-Summariser/poppler-24.08.0/README.fr.md)
 
 ---
 
-## Conclusion :  
-Malgré que l’application mérite quelque optimisations (que je n’aurais pas le temps de modifier à cause de l’école, j’ai des projets à rendre et des examens à faire), je suis très satisfait des compétences acquises, particulièrement en IA et l'utilisation InstallForge. InstallForge m'a en plus permis de comprendre indirectement quelques concepts systèmes très interessant que je ne connaissais pas encore. Je suis aussi content d'avoir utilisé Ttkboostrap pour faire le frontend, car j'aime et utilise déjà ce frontend pour les sites webs, même si je préfère largement l'utiliser en HTML, car je trouve la structure meilleure en HTML comparé à Python.
+### Installer Tesseract-OCR
+
+Téléchargement :  
+https://digi.bib.uni-mannheim.de/tesseract/
+
+Instructions pour l’installer **dans le projet** :  
+[PDF-Summariser/Tesseract-OCR/README.fr.md](/PDF-Summariser/Tesseract-OCR/README.fr.md)
 
 ---
 
 ## Remerciements
+
 Merci à David De Groote, qui nous a donné un séminaire très intéressant sur l'IA à l'École d'Informatique de Gestion de Delémont. Grâce à ce cours, j'ai pu réaliser ce projet. Son GitBook est disponible dans les liens ci-dessous.
 
 ---
 
 ## Liens :
+
 - [Installation Package OpenAI - ESIG](https://esig.degroote.ch/mardi-3-decembre-2024/pratique-api/installation-package-openai-et-test)
 - [OpenAI API Documentation](https://platform.openai.com/docs/api-reference/introduction)
 - [OpenAI Overview](https://platform.openai.com/docs/overview)