Second major update

Author: maximlt

.gitignore

@@ -1,7 +1,3 @@
-build
-.vscode
 dev.txt
 *\.ipynb_checkpoints
-__pycache__/
-TODOs.txt
-/source/_build
+__pycache__/

.vscode/settings.json

@@ -0,0 +1,59 @@
+{
+    "_restructuredtext.linter.extraArgs": [
+        "--ignore D002",
+        "--ignore D004"
+    ],
+    "files.autoSave": "afterDelay",
+    "spellright.language": [
+        "fr"
+    ],
+    "spellright.documentTypes": [
+        "markdown",
+        "latex",
+        "plaintext"
+    ],
+    "python.linting.enabled": false,
+    "python.pythonPath": "C:\\ProgramData\\Miniconda3\\envs\\pythonscript_dev\\python.exe",
+    "restructuredtext.confPath": "${workspaceFolder}\\source",
+    "restructuredtext.builtDocumentationPath": "${workspaceFolder}\\_build",
+    "restructuredtext.updateOnTextChanged": "true",
+    "restructuredtext.linter.name": "rstcheck",
+    "restructuredtext.updateDelay": 300,
+    "restructuredtext.linter.run": "onSave",
+    "restructuredtext.preview.name": "docutil",
+    "cSpell.language": "en,fr",
+    "cSpell.words": [
+        "CONDAPATH",
+        "ENVNAME",
+        "ENVPATH",
+        "INPUTFILE",
+        "Lorsqu'un",
+        "Matplotlib",
+        "Numpy",
+        "Rossum",
+        "Youtube",
+        "aujourd'hui",
+        "binder",
+        "chainage",
+        "conda",
+        "datascience",
+        "envs",
+        "geopandas",
+        "jupyter",
+        "kernel",
+        "kernels",
+        "lorsqu'il",
+        "lorsqu'on",
+        "manning",
+        "miniconda",
+        "myenv",
+        "overflow",
+        "parsefile",
+        "rasterio",
+        "scale",
+        "someenv",
+        "spyder",
+        "stackoverflow",
+        "timeit"
+    ],
+}

.vscode/spellright.dict

@@ -0,0 +1,93 @@
+StackOverflow
+Environment
+conda
+pip
+Spyder
+Overflow
+stackoverflow
+programming
+scale
+target
+Lab
+Bucket
+Rossum
+Num
+Geo
+Rasterio
+Matplotlib
+Cheat
+deprecated
+Jupyter
+jupyter
+ipynb
+Youtube
+Markdown
+Automating
+Boring
+Stuff
+with
+Practical
+Users
+autocompletion
+py
+wildcard
+dir
+Rectory
+cls
+echo
+notepad
+where
+calc
+Numpy
+channel
+Miniconda
+activate
+myenv
+list
+datascience
+create
+envs
+name
+env
+remove
+deactivate
+yml
+install
+uninstall
+d'autocomplétion
+History
+chdir
+path
+workingdirectory
+delete
+toogle
+indent
+unindent
+completion
+selection
+Context
+Shortcut
+Space
+clear
+array
+builder
+magic
+commands
+namespace
+timeit
+sum
+who
+whos
+lsmagic
+print
+quickref
+Ipython
+hint
+quit
+
+qtconsole
+Inline
+build
+virtualenv
+Find
+cell

dev.md

@@ -0,0 +1,9 @@
+# Construction du tutoriel
+
+## Conversion des notebooks en scripts python
+
+Les notebooks servent à la création du site. Les scripts peuvent être utilisés directement par Spyder.
+Le package `Jupytext` permet d'effectuer la conversion avec la commande:
+
+``jupytext --to py:percent --opt comment_magics=false file.ipynb``
+

exercices/culvert_logfile.txt exercices/loganalysis/culvert_logfile.txt

@@ -11,8 +11,13 @@
    backslashs)
 2. Exécuter le script avec  `python culvert_logparser.py`
 
+Dépendances:
+- python 3.7
+- pandas 1.0.5
+
 Historique:
 - ML (10/09/2019): Création du script
+- ML (09/07/2020): MAJ de la doc
 """
 # Les imports se placent par convention tout au début du fichier.
 # On importe pandas de la manière conventionnelle
@@ -21,7 +26,7 @@
 ###############################################################################
 ############################ Données d'entrée #################################
 ###############################################################################
-CULVERT_FILE_PATH ="culvert_logfile.txt"
+CULVERT_FILE_PATH = "culvert_logfile.txt"
 ###############################################################################
 
 # Indique visuellement le départ de l'exécution du script.

exercices/generate_dummy_file.py exercices/loganalysis/generate_dummy_file.py

@@ -0,0 +1,4 @@
+id,description
+1,rectangle
+2,triangle
+3,cercle

exercices/solution/culvert_dataanalysis.py exercices/loganalysis/solution/culvert_dataanalysis.py

@@ -0,0 +1,83 @@
+"""Script pour récupérer les données d'un fichier log culvert
+
+Description détaillée:
+Le script lit d'abord les données d'un fichier CSV. Ensuite, il ouvre un fichier 
+PDF et ajoute à page le texte formaté extrait du fichier CSV et enregistre le nouveau
+fichier PDF.
+
+Utilisation:
+1. Modifier les variables PDF_FILE_PATH et CSV_FILE_PATH pour qu'elles indiquent
+   le chemin vers les fichiers CSV et PDF. (r"path\to\file" si le chemin contient des
+   backslashs)
+2. Exécuter le script avec `python ajout_texte_pdf.py` ou F5 dans Spyder.
+
+Dépendances:
+- python 3.7
+- PyMuPDF 1.17.3
+
+Historique:
+- ML (09/07/2020): Création du script
+"""
+# Les imports se placent par convention tout au début du fichier.
+# Import du module CSV de la librairie standard dédié à la gestion des fichiers CSV
+import csv
+# Import du module système qui permet, entre autres, de quitter le programme
+import sys
+# Import de PyMuPDF (son nom d'import est différent)
+import fitz
+
+###############################################################################
+############################ Données d'entrée #################################
+###############################################################################
+CSV_FILE_PATH = r"..\shapes.csv"
+PDF_FILE_PATH = r"..\shapes.pdf"
+OUTPUT_PDF_FILE_PATH = r"..\shapes_with_text.pdf"
+###############################################################################
+
+# Indique visuellement le départ de l'exécution du script.
+print("Starting...")
+
+# Création de listes vides prêtes à contenir les données du fichier CSV.
+shape_ids = []
+shape_descriptions = []
+
+# Ouverture du fichier texte
+with open(CSV_FILE_PATH, mode="r", encoding="utf-8") as csv_file:
+    # On utilise l'object DictReader du module CSV qui suppose que la première
+    # ligne du fichier CSV est une ligne d'en-tête, ce qui est le cas ici.
+    csv_reader = csv.DictReader(csv_file)
+    # On peut itérer sur cet objet, et extraire ligne par ligne les données.
+    for row in csv_reader:
+        shape_ids.append(row["id"])
+        shape_descriptions.append(row["description"])
+
+
+# On ouvre le fichier PDF dans un context manager fourni par la fonction open de PyMuPDF
+with fitz.open(PDF_FILE_PATH) as pdf:
+
+    # On vérifie ici que le nombre de page du fichier PDF correspond bien
+    # au nombre d'entrée dans le fichier CSV. Sinon on quitte le programme.
+    if len(pdf) != len(shape_ids):
+        print("Le fichier CSV et le fichier PDF ne contiennent pas le même nombre d'éléments.")
+        sys.exit()  # Arrêt du script
+    
+    # On effectue une boucle au travers des éléments du CSV et des pages du fichier PDF
+    for shape_id, shape_description, page in zip(shape_ids, shape_descriptions, pdf):
+        # Création du texte à rajouter, \n permet de sauter des lignes
+        text = f"ID: {shape_id}\nType: {shape_description}\nAjouté par PyMuPDF"
+        # Ajout du texte à chaque page.
+        # On note que cela ne modifie pas directement le fichier ouvert, cela enregistre
+        # dans la mémoire de nouvelles pages PDF.
+        page.insertText(
+            fitz.Point(100, 50),  # Position du texte
+            text,
+            fontsize=10,
+            color=(0, 0, 1)  # bleu
+        )
+
+    # Lorsque la boucle est terminée, on enregistre le fichier PDF sous un nouveau nom.
+    output_pdf_file = r"..\shapes_with_text.pdf"
+    pdf.save(OUTPUT_PDF_FILE_PATH)
+
+# Indique visuellement que le script s'est bien executé jusqu'au bout.
+print("Done!")