jupyter-analysis-tools 1.4.1__tar.gz → 1.5.0__tar.gz

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/.copier-answers.yml

@@ -22,4 +22,4 @@ repo_main_branch: main
 repo_name: jupyter-analysis-tools
 repo_userorg: BAMresearch
 sphinx_theme: furo
-version: 1.4.1
+version: 1.5.0

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## v1.5.0 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: rename command readSSFZ -> ssfz2json for avoiding name collision with function in readdata module ([`dde1d10`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/dde1d109b70de0cd0cb712cfc4f19a3be2cbd880))
+
+### Features
+
+* **readdata**: jupyter_analysis_tools.readSSFZ cmdline tool to convert .SSFZ to .JSON and diff-compare .SSFZ files (their metadata) ([`46dc633`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/46dc6338052a9dd875326d2a38cc5b6621439270))
+
+### Refactoring
+
+* **utils**: formatting ([`b23f195`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/b23f1957149a9ae77a28f330eba3249d3fe3d2e5))
+
+## v1.4.3 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() should return input path if no changes needed ([`2ec96d7`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/2ec96d7066a3473c6d27a6e6d01c640f6c142346))
+
+## v1.4.2 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() with FQDN resolution ([`f4591fb`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/f4591fb46dcfeafbb1f63c4323efbb8aea302a92))
+
 ## v1.4.1 (2025-08-01)
 
 ### Bug fixes

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.4.1
+Version: 1.5.0
 Summary: Yet another Python library with helpers and utilities for data analysis and processing.
 Author-email: Ingo Breßler <ingo.bressler@bam.de>, "Brian R. Pauw" <brian.pauw@bam.de>
 License-Expression: MIT
@@ -35,10 +35,10 @@ Requires-Dist: matplotlib
 Requires-Dist: ipywidgets
 Dynamic: license-file
 
-# Jupyter Analysis Tools (v1.4.1)
+# Jupyter Analysis Tools (v1.5.0)
 
 [![PyPI Package latest release](https://img.shields.io/pypi/v/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
-[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.4.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.4.1...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
 [![License](https://img.shields.io/pypi/l/jupyter-analysis-tools.svg)](https://en.wikipedia.org/wiki/MIT_license)
 [![Supported versions](https://img.shields.io/pypi/pyversions/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
 [![PyPI Wheel](https://img.shields.io/pypi/wheel/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools#files)
@@ -97,6 +97,32 @@ are installed:
 
 # CHANGELOG
 
+## v1.5.0 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: rename command readSSFZ -> ssfz2json for avoiding name collision with function in readdata module ([`dde1d10`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/dde1d109b70de0cd0cb712cfc4f19a3be2cbd880))
+
+### Features
+
+* **readdata**: jupyter_analysis_tools.readSSFZ cmdline tool to convert .SSFZ to .JSON and diff-compare .SSFZ files (their metadata) ([`46dc633`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/46dc6338052a9dd875326d2a38cc5b6621439270))
+
+### Refactoring
+
+* **utils**: formatting ([`b23f195`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/b23f1957149a9ae77a28f330eba3249d3fe3d2e5))
+
+## v1.4.3 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() should return input path if no changes needed ([`2ec96d7`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/2ec96d7066a3473c6d27a6e6d01c640f6c142346))
+
+## v1.4.2 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() with FQDN resolution ([`f4591fb`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/f4591fb46dcfeafbb1f63c4323efbb8aea302a92))
+
 ## v1.4.1 (2025-08-01)
 
 ### Bug fixes

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/README.md

@@ -1,7 +1,7 @@
-# Jupyter Analysis Tools (v1.4.1)
+# Jupyter Analysis Tools (v1.5.0)
 
 [![PyPI Package latest release](https://img.shields.io/pypi/v/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
-[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.4.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.4.1...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
 [![License](https://img.shields.io/pypi/l/jupyter-analysis-tools.svg)](https://en.wikipedia.org/wiki/MIT_license)
 [![Supported versions](https://img.shields.io/pypi/pyversions/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
 [![PyPI Wheel](https://img.shields.io/pypi/wheel/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools#files)

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/docs/conf.py

@@ -32,7 +32,7 @@ project = "Jupyter Analysis Tools"
 year = "2018-2025"
 author = "Ingo Breßler and Brian R. Pauw"
 copyright = "{0}, {1}".format(year, author)
-version = "1.4.1"
+version = "1.5.0"
 release = version
 commit_id = None
 try:

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/pyproject.toml

@@ -41,6 +41,9 @@ documentation = "https://BAMresearch.github.io/jupyter-analysis-tools"
 repository = "https://github.com/BAMresearch/jupyter-analysis-tools"
 changelog = "https://BAMresearch.github.io/jupyter-analysis-tools/changelog.html"
 
+[project.scripts]
+ssfz2json = "jupyter_analysis_tools.ssfz2json:main"
+
 [build-system]
 requires = [
     "setuptools>=40.6",

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/src/jupyter_analysis_tools/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # __init__.py
 
-__version__ = "1.4.1"
+__version__ = "1.5.0"
 
 from .binning import reBin
 from .git import checkRepo, isNBstripoutActivated, isNBstripoutInstalled, isRepo

jupyter_analysis_tools-1.5.0/src/jupyter_analysis_tools/ssfz2json.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+# ssfz2json.py
+
+import argparse
+import json
+import sys
+from pathlib import Path
+
+from jupyter_analysis_tools.readdata import readSSFZ
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="""
+            Reads and parses a .SSFZ file created by Anton Paar SAXSquant software and writes them
+            back to disk as .JSON file under the same base name if no other output name was given.
+
+            If two .SSFZ files are provided, a diff-like comparison of metadata is output and the
+            *outPath* argument is ignored.
+            """
+    )
+    parser.add_argument(
+        "-i",
+        "--inPath",
+        type=lambda p: Path(p).absolute(),
+        help="Path of the input .SSFZ file to read.",
+        required=True,
+    )
+    parser.add_argument(
+        "-c",
+        "--comparePath",
+        type=lambda p: Path(p).absolute(),
+        help="Path of a 2nd .SSFZ file to compare its metadata against the 1st one.",
+    )
+    parser.add_argument(
+        "-o",
+        "--outPath",
+        type=lambda p: Path(p).absolute(),
+        help="Output file Path to write the JSON data to.",
+    )
+    json_args = dict(sort_keys=True, indent=2)
+    args = parser.parse_args()
+    if not args.inPath.is_file():
+        print(f"Provided file '{args.inPath}' not found!")
+        return 1
+    in_data = readSSFZ(args.inPath)
+    if args.comparePath is not None:
+        import difflib
+
+        comp_data = readSSFZ(args.comparePath)
+        diff = difflib.unified_diff(
+            json.dumps(in_data, **json_args).splitlines(keepends=True),
+            json.dumps(comp_data, **json_args).splitlines(keepends=True),
+            fromfile=str(args.inPath),
+            tofile=str(args.comparePath),
+        )
+        for line in diff:
+            print(line, end="")
+    else:  # just write JSON to outPath
+        if args.outPath is None:
+            args.outPath = args.inPath.with_suffix(args.inPath.suffix + ".json")
+        with open(args.outPath, "w") as fd:
+            json.dump(in_data, fd, **json_args)
+        print(f"Wrote '{args.outPath}'.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/src/jupyter_analysis_tools/utils.py

@@ -106,16 +106,32 @@ def addEnvScriptsToPATH():
         os.environ["PATH"] = sep.join(environPATH)
 
 
-def networkdriveMapping(cmdOutput: str = None):
+def networkdriveMapping(cmdOutput: str = None, resolveNames: bool = True):
     """Returns a dict of mapping drive letters to network paths (on Windows)."""
     if isWindows():
         if cmdOutput is None:
             proc = subprocess.run(["net", "use"], capture_output=True, text=True, encoding="cp850")
             cmdOutput = proc.stdout
+
+        def resolveFQDN(uncPath):
+            if not resolveNames:
+                return uncPath
+            parts = uncPath.split("\\")
+            idx = [i for i, part in enumerate(parts) if len(part)][0]
+            proc = subprocess.run(
+                ["nslookup", parts[idx]], capture_output=True, text=True, encoding="cp850"
+            )
+            res = [line.split() for line in proc.stdout.splitlines() if line.startswith("Name:")]
+            if len(res) and len(res[0]) == 2:
+                parts[idx] = res[0][1]
+            return "\\".join(parts)
+
         rows = [line.split() for line in cmdOutput.splitlines() if "Windows Network" in line]
-        rows = dict(
-            [row[1:3] for row in rows if row[1].endswith(":") and row[2].startswith("\\\\")]
-        )
+        rows = {
+            row[1]: resolveFQDN(row[2])
+            for row in rows
+            if row[1].endswith(":") and row[2].startswith(r"\\")
+        }
         return rows
     else:  # Linux (tested) or macOS (untested)
         if cmdOutput is None:
@@ -143,17 +159,17 @@ def networkdriveMapping(cmdOutput: str = None):
     return {}
 
 
-def makeNetworkdriveAbsolute(filepath, cmdOutput: str = None):
+def makeNetworkdriveAbsolute(filepath, cmdOutput: str = None, resolveNames: bool = True):
     """Replaces the drive letter of the given path by the respective network path, if possible."""
     if filepath.drive.startswith(r"\\"):
-        return  # it's a UNC path already
+        return filepath  # it's a UNC path already
     if isWindows():
-        drivemap = networkdriveMapping(cmdOutput=cmdOutput)
+        drivemap = networkdriveMapping(cmdOutput=cmdOutput, resolveNames=resolveNames)
         prefix = drivemap.get(filepath.drive, None)
         if prefix is not None:
             filepath = Path(prefix).joinpath(*filepath.parts[1:])
     else:  # Linux or macOS
-        drivemap = networkdriveMapping(cmdOutput=cmdOutput)
+        drivemap = networkdriveMapping(cmdOutput=cmdOutput, resolveNames=resolveNames)
         # search for the mountpoint, starting with the longest, most specific, first
         for mp, target in sorted(drivemap.items(), key=lambda tup: len(tup[0]), reverse=True):
             if filepath.is_relative_to(mp):

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/src/jupyter_analysis_tools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.4.1
+Version: 1.5.0
 Summary: Yet another Python library with helpers and utilities for data analysis and processing.
 Author-email: Ingo Breßler <ingo.bressler@bam.de>, "Brian R. Pauw" <brian.pauw@bam.de>
 License-Expression: MIT
@@ -35,10 +35,10 @@ Requires-Dist: matplotlib
 Requires-Dist: ipywidgets
 Dynamic: license-file
 
-# Jupyter Analysis Tools (v1.4.1)
+# Jupyter Analysis Tools (v1.5.0)
 
 [![PyPI Package latest release](https://img.shields.io/pypi/v/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
-[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.4.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.4.1...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
 [![License](https://img.shields.io/pypi/l/jupyter-analysis-tools.svg)](https://en.wikipedia.org/wiki/MIT_license)
 [![Supported versions](https://img.shields.io/pypi/pyversions/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools)
 [![PyPI Wheel](https://img.shields.io/pypi/wheel/jupyter-analysis-tools.svg)](https://pypi.org/project/jupyter-analysis-tools#files)
@@ -97,6 +97,32 @@ are installed:
 
 # CHANGELOG
 
+## v1.5.0 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: rename command readSSFZ -> ssfz2json for avoiding name collision with function in readdata module ([`dde1d10`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/dde1d109b70de0cd0cb712cfc4f19a3be2cbd880))
+
+### Features
+
+* **readdata**: jupyter_analysis_tools.readSSFZ cmdline tool to convert .SSFZ to .JSON and diff-compare .SSFZ files (their metadata) ([`46dc633`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/46dc6338052a9dd875326d2a38cc5b6621439270))
+
+### Refactoring
+
+* **utils**: formatting ([`b23f195`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/b23f1957149a9ae77a28f330eba3249d3fe3d2e5))
+
+## v1.4.3 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() should return input path if no changes needed ([`2ec96d7`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/2ec96d7066a3473c6d27a6e6d01c640f6c142346))
+
+## v1.4.2 (2025-08-01)
+
+### Bug fixes
+
+* **utils**: makeNetworkdriveAbsolute() with FQDN resolution ([`f4591fb`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/f4591fb46dcfeafbb1f63c4323efbb8aea302a92))
+
 ## v1.4.1 (2025-08-01)
 
 ### Bug fixes

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/src/jupyter_analysis_tools.egg-info/SOURCES.txt

@@ -31,11 +31,13 @@ src/jupyter_analysis_tools/distrib.py
 src/jupyter_analysis_tools/git.py
 src/jupyter_analysis_tools/plotting.py
 src/jupyter_analysis_tools/readdata.py
+src/jupyter_analysis_tools/ssfz2json.py
 src/jupyter_analysis_tools/utils.py
 src/jupyter_analysis_tools/widgets.py
 src/jupyter_analysis_tools.egg-info/PKG-INFO
 src/jupyter_analysis_tools.egg-info/SOURCES.txt
 src/jupyter_analysis_tools.egg-info/dependency_links.txt
+src/jupyter_analysis_tools.egg-info/entry_points.txt
 src/jupyter_analysis_tools.egg-info/requires.txt
 src/jupyter_analysis_tools.egg-info/top_level.txt
 templates/CHANGELOG.md.j2

jupyter_analysis_tools-1.5.0/src/jupyter_analysis_tools.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ssfz2json = jupyter_analysis_tools.ssfz2json:main

{jupyter_analysis_tools-1.4.1 → jupyter_analysis_tools-1.5.0}/tests/utils.py

@@ -83,7 +83,7 @@ def test_appendToPATH(capsys):
 
 def test_networkdriveMapping():
     if isWindows():
-        map = networkdriveMapping(cmdOutput=outNetUse)
+        map = networkdriveMapping(cmdOutput=outNetUse, resolveNames=False)
         assert map == {
             "G:": "\\\\ALPHA\\BETA",
             "K:": "\\\\GAM\\MMA",
@@ -91,7 +91,7 @@ def test_networkdriveMapping():
             "T:": "\\\\test\\foldername",
         }
     else:  # Linux or macOS
-        map = networkdriveMapping(cmdOutput=outMount)
+        map = networkdriveMapping(cmdOutput=outMount, resolveNames=False)
         assert map == {
             "/mnt/gh 12": "//xyz04.fgsd.asd.com/G2S/GH31",
             "/mnt/some (ugly) on type name": "//abc02.def.ault.de/X23/somename",
@@ -101,12 +101,12 @@ def test_networkdriveMapping():
 def test_makeNetworkdriveAbsolute():
     if isWindows():
         filepath = Path(r"M:\some\folders\a file name.ext")
-        newpath = makeNetworkdriveAbsolute(filepath, cmdOutput=outNetUse)
+        newpath = makeNetworkdriveAbsolute(filepath, cmdOutput=outNetUse, resolveNames=False)
         assert filepath != newpath
         assert newpath == Path(r"\\user\drive\uname\some\folders\a file name.ext")
     else:  # Linux or macOS
         filepath = Path("/mnt/some (ugly) on type name/some/folders/a file name.ext")
-        newpath = makeNetworkdriveAbsolute(filepath, cmdOutput=outMount)
+        newpath = makeNetworkdriveAbsolute(filepath, cmdOutput=outMount, resolveNames=False)
         assert filepath != newpath
         assert newpath == Path("//abc02.def.ault.de/X23/somename/some/folders/a file name.ext")