chore: topofileformats > AFMReader for module and update imports

+ Forgot the `topofileformats` directory that holds package needs renaming to `AFMReader`. + Updates all imports to work with new package name.
AFM-SPM · May 7, 2024 · c30ed9f · c30ed9f
1 parent 6732a36
commit c30ed9f
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 9 deletions.
diff --git a/topofileformats/__init__.py → AFMReader/__init__.py b/topofileformats/__init__.py → AFMReader/__init__.py
diff --git a/topofileformats/asd.py → AFMReader/asd.py b/topofileformats/asd.py → AFMReader/asd.py
@@ -12,8 +12,8 @@
 from matplotlib import animation
 
 
-from topofileformats.logging import logger
-from topofileformats.io import (
+from AFMReader.logging import logger
+from AFMReader.io import (
     read_int32,
     read_int16,
     read_float,

diff --git a/topofileformats/ibw.py → AFMReader/ibw.py b/topofileformats/ibw.py → AFMReader/ibw.py
@@ -6,7 +6,7 @@
 import numpy as np
 from igor2 import binarywave
 
-from topofileformats.logging import logger
+from AFMReader.logging import logger
 
 logger.enable(__package__)
 
@@ -66,7 +66,7 @@ def load_ibw(file_path: Path | str, channel: str) -> tuple[np.ndarray, float]:
     Load the image and pixel to nanometre scaling factor - 'HeightTracee' is the default channel name (the extra 'e' is
     not a typo!).
 
-    >>> from topofileformats.ibw import load_ibw
+    >>> from AFMReader.ibw import load_ibw
     >>> image, pixel_to_nanometre_scaling_factor = load_ibw(file_path="./my_ibw_file.ibw", channel="HeightTracee")
     """
     logger.info(f"Loading image from : {file_path}")

diff --git a/topofileformats/io.py → AFMReader/io.py b/topofileformats/io.py → AFMReader/io.py
diff --git a/topofileformats/jpk.py → AFMReader/jpk.py b/topofileformats/jpk.py → AFMReader/jpk.py
@@ -6,7 +6,7 @@
 import numpy as np
 import tifffile
 
-from topofileformats.logging import logger
+from AFMReader.logging import logger
 
 logger.enable(__package__)
 
@@ -63,7 +63,7 @@ def load_jpk(file_path: Path | str, channel: str) -> tuple[np.ndarray, float]:
     --------
     Load height trace channel from the .jpk file. 'height_trace' is the default channel name.
 
-    >>> from topofileformats.jpk import load_jpk
+    >>> from AFMReader.jpk import load_jpk
     >>> image, pixel_to_nanometre_scaling_factor = load_jpk(file_path="./my_jpk_file.jpk", channel="height_trace")
     """
     logger.info(f"Loading image from : {file_path}")

diff --git a/topofileformats/logging.py → AFMReader/logging.py b/topofileformats/logging.py → AFMReader/logging.py
diff --git a/topofileformats/spm.py → AFMReader/spm.py b/topofileformats/spm.py → AFMReader/spm.py
@@ -6,7 +6,7 @@
 import pySPM
 import numpy as np
 
-from topofileformats.logging import logger
+from AFMReader.logging import logger
 
 logger.enable(__package__)
 
@@ -72,7 +72,7 @@ def load_spm(file_path: Path | str, channel: str) -> tuple:
     Load the image and pixel to nanometre scaling factor, available channels are 'Height', 'ZSensor' and 'Height
     Sensor'.
 
-    >>> from topofileformats.spm import load_spm
+    >>> from AFMReader.spm import load_spm
     >>> image, pixel_to_nm = load_spm(file_path="path/to/file.spm", channel="Height")
     ```
     """

diff --git a/pyproject.toml b/pyproject.toml
@@ -48,7 +48,8 @@ dev = [
   "pytest",
   "pytest-cov",
   "pylint",
-  "ruff"
+  "ruff",
+  "setuptools_scm[toml]",
 ]
 
 [project.urls]