From 12555dc373e928b121ac559406e4963e026a9074 Mon Sep 17 00:00:00 2001 From: "Julien M." Date: Tue, 18 Jun 2024 00:27:40 +0200 Subject: [PATCH] improve(processing): move single progress outside quick fail or normal mode blocks --- dicogis/georeaders/process_files.py | 20 ++++++++------------ docs/index.md | 16 ++++++++++++++++ 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/dicogis/georeaders/process_files.py b/dicogis/georeaders/process_files.py index 1f24ae4e..9e935776 100644 --- a/dicogis/georeaders/process_files.py +++ b/dicogis/georeaders/process_files.py @@ -259,16 +259,16 @@ def export_metadataset( Returns: dataset to process, metadataset or None if something went wrong """ + self.update_progress( + message_to_display="Exporting metadata of " + f"{dataset_to_process.file_path.name}..." + ) if self.opt_quick_fail: - self.update_progress( - message_to_display="Exporting metadata of " - f"{dataset_to_process.file_path}..." - ) # writing to the Excel file self.serializer.serialize_metadaset(metadataset=metadataset_to_serialize) self.update_progress( - message_to_display="Exporting metadata of " - f"{dataset_to_process.file_path}: OK", + message_to_display="Metadata of " + f"{dataset_to_process.file_path.name}: EXPORTED", increment_counter=True, ) logger.debug(f"Exporting metadata of {dataset_to_process.file_path}: OK") @@ -276,15 +276,11 @@ def export_metadataset( return dataset_to_process, metadataset_to_serialize try: - self.update_progress( - message_to_display="Exporting metadata of " - f"{dataset_to_process.file_path}..." - ) # writing to the Excel file self.serializer.serialize_metadaset(metadataset=metadataset_to_serialize) self.update_progress( - message_to_display="Exporting metadata of " - f"{dataset_to_process.file_path}: OK", + message_to_display="Metadata of " + f"{dataset_to_process.file_path.name}: EXPORTED", increment_counter=True, ) logger.debug(f"Exporting metadata of {dataset_to_process.file_path}: OK") diff --git a/docs/index.md b/docs/index.md index f1fc3305..6428050b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,6 +15,22 @@ A quickview video: ---- +## Quickstart + +If you are on a recent Linux distribution like Ubuntu 22.04 and higher with Python 3.10+ and GDAL installed, you can try something like this: + +```sh +cd /tmp/ +mkdir test-dicogis +cd test-dicogis/ +python3 -m venv .venv +. .venv/bin/activate +python -m pip install -U pip setuptools wheel + +``` + +---- + ```{toctree} --- maxdepth: 1