fixed imports by running as a module

K-ShakeTune/shaketune.sh

@@ -1,5 +1,10 @@
 #!/usr/bin/env bash
 
+# This script is used to run the Shake&Tune Python scripts as a module
+# from the project root directory using its virtual environment
+# Usage: ./shaketune.sh <args>
+
 source ~/klippain_shaketune-env/bin/activate
-python ~/klippain_shaketune/src/is_workflow.py "$@"
+cd ~/klippain_shaketune
+python -m src.is_workflow "$@"
 deactivate

src/graph_creators/analyze_axesmap.py

@@ -10,7 +10,7 @@ import optparse
 import numpy as np
 from scipy.signal import butter, filtfilt
 
-from helpers.locale_utils import print_with_c_locale
+from ..helpers.locale_utils import print_with_c_locale
 
 NUM_POINTS = 500
 

src/graph_creators/graph_belts.py

@@ -20,14 +20,14 @@ from scipy.interpolate import griddata
 
 matplotlib.use('Agg')
 
-from helpers.common_func import (
+from ..helpers.common_func import (
     compute_curve_similarity_factor,
     compute_spectrogram,
     detect_peaks,
     parse_log,
     setup_klipper_import,
 )
-from helpers.locale_utils import print_with_c_locale, set_locale
+from ..helpers.locale_utils import print_with_c_locale, set_locale
 
 ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'  # For paired peaks names
 

src/graph_creators/graph_shaper.py

@@ -20,14 +20,14 @@ import numpy as np
 
 matplotlib.use('Agg')
 
-from helpers.common_func import (
+from ..helpers.common_func import (
     compute_mechanical_parameters,
     compute_spectrogram,
     detect_peaks,
     parse_log,
     setup_klipper_import,
 )
-from helpers.locale_utils import print_with_c_locale, set_locale
+from ..helpers.locale_utils import print_with_c_locale, set_locale
 
 PEAKS_DETECTION_THRESHOLD = 0.05
 PEAKS_EFFECT_THRESHOLD = 0.12

src/graph_creators/graph_vibrations.py

@@ -21,14 +21,14 @@ import numpy as np
 
 matplotlib.use('Agg')
 
-from helpers.common_func import (
+from ..helpers.common_func import (
     compute_mechanical_parameters,
     detect_peaks,
     identify_low_energy_zones,
     parse_log,
     setup_klipper_import,
 )
-from helpers.locale_utils import print_with_c_locale, set_locale
+from ..helpers.locale_utils import print_with_c_locale, set_locale
 
 PEAKS_DETECTION_THRESHOLD = 0.05
 PEAKS_RELATIVE_HEIGHT_THRESHOLD = 0.04

src/helpers/filemanager.py

@@ -6,8 +6,6 @@
 import time
 from pathlib import Path
 
-from is_workflow import Config
-
 
 def wait_file_ready(filepath: Path) -> None:
     file_busy = True
@@ -37,7 +35,6 @@ def wait_file_ready(filepath: Path) -> None:
         time.sleep(1)
 
 
-def ensure_folders_exist() -> None:
+def ensure_folders_exist(folders: list[Path]) -> None:
-    for subfolder in Config.RESULTS_SUBFOLDERS.values():
+    for folder in folders:
-        folder = Config.RESULTS_BASE_FOLDER / subfolder
+        folder.mkdir(parents=True, exist_ok=True)
-        Path(folder).mkdir(parents=True, exist_ok=True)

src/is_workflow.py

@@ -20,12 +20,12 @@ from typing import Callable, Optional
 from git import GitCommandError, Repo
 from matplotlib.figure import Figure
 
-import helpers.filemanager as fm
+import src.helpers.filemanager as fm
-from graph_creators.analyze_axesmap import axesmap_calibration
+from src.graph_creators.analyze_axesmap import axesmap_calibration
-from graph_creators.graph_belts import belts_calibration
+from src.graph_creators.graph_belts import belts_calibration
-from graph_creators.graph_shaper import shaper_calibration
+from src.graph_creators.graph_shaper import shaper_calibration
-from graph_creators.graph_vibrations import vibrations_profile
+from src.graph_creators.graph_vibrations import vibrations_profile
-from helpers.locale_utils import print_with_c_locale
+from src.helpers.locale_utils import print_with_c_locale
 
 
 class Config:
@@ -358,7 +358,9 @@ class AxesMapFinder:
 
 def main():
     options = Config.parse_arguments()
-    fm.ensure_folders_exist()
+    fm.ensure_folders_exist(
+        folders=[Config.RESULTS_BASE_FOLDER / subfolder for subfolder in Config.RESULTS_SUBFOLDERS.values()]
+    )
 
     print_with_c_locale(f'Shake&Tune version: {Config.get_git_version()}')