Mise à jour README

This commit is contained in:
David Castex 2025-06-30 14:31:17 +02:00
parent cf8d29daf0
commit 115a3748f7

View File

@ -31,12 +31,12 @@ Vous pouvez fermer les fenêtres apparues une fois le script terminé. Bien jou
### ⛪ Historique ⛪ ### ⛪ Historique ⛪
Après avoir lu et compris le contenu de l'ancien script, et avoir apporté quelques modifications, j'ai plutot décidé de repartir de zéro. Après avoir lu et compris le contenu de l'ancien script, et avoir apporté quelques modifications, j'ai plutot décidé de repartir de zéro.
Ma première version était divisée en plusieurs modules et fichiers. Ma première version était divisé en plusieurs modules et fichiers.
Mais pour une question d'ergonomie dans l'utilisation, j'ai tout regroupé sur un seul fichier. Mais pour une question d'ergonomie dans l'utilisation, j'ai tout regroupé sur un seul fichier.
### 🧪 Tests unitaires 🧪 ### 🧪 Tests unitaires 🧪
Dans l'optique de m'exercer, j'ai créé dans l'ancienne version des tests unitaires pour chaque fonction et classe. Malheuresement, je ne les ai pas mis a jour avec la dernière version, ils ne sont donc pour le moment plus fonctionnels. Dans l'optique de m'exercer, j'ai créé dans l'ancienne version des tests unitaires pour chaque fonction et classe. Malheuresement, je ne les ai pas mis a jour avec la dernière version, ils ne sont donc pour le moment plus fonctionnels. [Voir détails](#-lancer-les-tests-)
### 🔃 Déroulé du programme 🔃 ### 🔃 Déroulé du programme 🔃
@ -95,6 +95,8 @@ sur des points de controles qui ne seraient pas passés.
### 🛂🚧 Les points de controles réalisés 🚧🛂 ### 🛂🚧 Les points de controles réalisés 🚧🛂
La liste n'est pas exhaustive, le code est commenté
#### 1. 🚦Intersection CC47 et Lambert93 🚦 #### 1. 🚦Intersection CC47 et Lambert93 🚦
Voir shémas (TODO) Voir shémas (TODO)
@ -135,5 +137,40 @@ De ce point de vue, il y a certainement beaucoup d'optimisation.
Donc oui, ce script n'est pas optimal. Mais, il est robuste (plutot) et fonctionnel pour l'usage prévu en production. Donc oui, ce script n'est pas optimal. Mais, il est robuste (plutot) et fonctionnel pour l'usage prévu en production.
Notez également qu'il n'y a eu aucun recours à de l'IA. L'exercice consistait aussi à conceptualiser les besoins. Notez également qu'il n'y a eu aucun recours à de l'IA. L'exercice consistait aussi à conceptualiser les besoins, les représentations de données et l'algorithme.
TODO Explication avancées.
### 🔧 Lancer les Tests 🔧
Pour lancer les tests, il faudra préalablement installer un environnement de travail isolé
```bash
python -m venv venv
```
Puis basculer vers cet environnement (a faire à chaque fois qu'on ouvre un shell)
```bash
source venv/Scripts/activate
```
Sous Windows ce sera `env\Scripts\activate.bat`
J'ai utiliser Pytest pour les tests et son module pytest-mock
```bash
pip install pytest
pip install pytest-mock
```
Les tests sont situés dans le dossier `test/` pour les lancer tous, depuis la racine du projet :
```
pytest test/
```
## Auteurs
- [@david.castex](https://gitea.digitanie.org/david.castex)