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

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

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

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

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v1.5.1 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: split in two: ssfz2json for converting, ssfz_compare for diff-like compare ([`e8b24fe`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/e8b24fe796430bb4b09fa23dcd204e6162051f79))
+
 ## v1.5.0 (2025-08-04)
 
 ### Bug fixes

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.5.0
+Version: 1.5.1
 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.5.0)
+# Jupyter Analysis Tools (v1.5.1)
 
 [![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.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.1...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,12 @@ are installed:
 
 # CHANGELOG
 
+## v1.5.1 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: split in two: ssfz2json for converting, ssfz_compare for diff-like compare ([`e8b24fe`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/e8b24fe796430bb4b09fa23dcd204e6162051f79))
+
 ## v1.5.0 (2025-08-04)
 
 ### Bug fixes

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

@@ -1,7 +1,7 @@
-# Jupyter Analysis Tools (v1.5.0)
+# Jupyter Analysis Tools (v1.5.1)
 
 [![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.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.1...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.5.0 → jupyter_analysis_tools-1.5.1}/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.5.0"
+version = "1.5.1"
 release = version
 commit_id = None
 try:

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

@@ -43,6 +43,7 @@ changelog = "https://BAMresearch.github.io/jupyter-analysis-tools/changelog.html
 
 [project.scripts]
 ssfz2json = "jupyter_analysis_tools.ssfz2json:main"
+ssfz-compare = "jupyter_analysis_tools.ssfz_compare:main"
 
 [build-system]
 requires = [

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

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

jupyter_analysis_tools-1.5.1/src/jupyter_analysis_tools/ssfz2json.py

@@ -0,0 +1,57 @@
+# -*- 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 the embedded metadata of a .SSFZ file created by Anton Paar SAXSquant
+            software, converts it to JSON format and outputs it to <stdout>.
+            An output file path for the JSON data can be provided by optional argument.
+            """
+    )
+    parser.add_argument(
+        "ssfzPath",
+        type=lambda p: Path(p).absolute(),
+        help="Path of the input .SSFZ file to read.",
+    )
+    parser.add_argument(
+        "-o",
+        "--out",
+        nargs="?",
+        default="stdout",
+        help=(
+            "Output file path to write the JSON data to. If the filename is omitted, "
+            "it is derived from the input file name by adding the .json suffix."
+        ),
+    )
+    args = parser.parse_args()
+    # print(args)
+    if not args.ssfzPath.is_file():
+        print(f"Provided file '{args.ssfzPath}' not found!")
+        return 1
+    data = readSSFZ(args.ssfzPath)
+    json_args = dict(sort_keys=True, indent=2)
+    if args.out == "stdout":
+        print(json.dumps(data, **json_args))
+    else:
+        if args.out is None:
+            args.out = args.ssfzPath.with_suffix(args.ssfzPath.suffix + ".json")
+        if not Path(args.out).parent.is_dir():
+            print(f"Directory of provided output file '{args.out}' does not exist!")
+            return 1
+        with open(args.out, "w") as fd:
+            json.dump(data, fd, **json_args)
+        print(f"Wrote '{args.out}'.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

jupyter_analysis_tools-1.5.1/src/jupyter_analysis_tools/ssfz_compare.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# ssfz2json.py
+
+import argparse
+import difflib
+import json
+import sys
+from pathlib import Path
+
+from jupyter_analysis_tools.readdata import readSSFZ
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="""
+            Reads and parses the embedded metadata of two .SSFZ files created by Anton Paar
+            SAXSquant software, converts them to JSON format and performs a diff-like comparison
+            which is output on <stdout>.
+            """
+    )
+    parser.add_argument(
+        "fromfile",
+        type=lambda p: Path(p).absolute(),
+        help="Path of the first .SSFZ file to compare.",
+    )
+    parser.add_argument(
+        "tofile",
+        type=lambda p: Path(p).absolute(),
+        help="Path of the second .SSFZ file to compare to.",
+    )
+    json_args = dict(sort_keys=True, indent=2)
+    args = parser.parse_args()
+    # print(args)
+    if not args.fromfile.is_file():
+        print(f"Provided file '{args.fromfile}' not found!")
+        return 1
+    if not args.tofile.is_file():
+        print(f"Provided file '{args.tofile}' not found!")
+        return 1
+    olddata = readSSFZ(args.fromfile)
+    newdata = readSSFZ(args.tofile)
+    diff = difflib.unified_diff(
+        json.dumps(olddata, **json_args).splitlines(keepends=True),
+        json.dumps(newdata, **json_args).splitlines(keepends=True),
+        fromfile=str(args.fromfile),
+        tofile=str(args.tofile),
+    )
+    for line in diff:
+        print(line, end="")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.5.0
+Version: 1.5.1
 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.5.0)
+# Jupyter Analysis Tools (v1.5.1)
 
 [![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.5.0.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.0...main)
+[![Commits since latest release](https://img.shields.io/github/commits-since/BAMresearch/jupyter-analysis-tools/v1.5.1.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.5.1...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,12 @@ are installed:
 
 # CHANGELOG
 
+## v1.5.1 (2025-08-04)
+
+### Bug fixes
+
+* **readSSFZ**: split in two: ssfz2json for converting, ssfz_compare for diff-like compare ([`e8b24fe`](https://github.com/BAMresearch/jupyter-analysis-tools/commit/e8b24fe796430bb4b09fa23dcd204e6162051f79))
+
 ## v1.5.0 (2025-08-04)
 
 ### Bug fixes

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

@@ -32,6 +32,7 @@ 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/ssfz_compare.py
 src/jupyter_analysis_tools/utils.py
 src/jupyter_analysis_tools/widgets.py
 src/jupyter_analysis_tools.egg-info/PKG-INFO

{jupyter_analysis_tools-1.5.0 → jupyter_analysis_tools-1.5.1}/src/jupyter_analysis_tools.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
+ssfz-compare = jupyter_analysis_tools.ssfz_compare:main
 ssfz2json = jupyter_analysis_tools.ssfz2json:main

jupyter_analysis_tools-1.5.0/src/jupyter_analysis_tools/ssfz2json.py

@@ -1,69 +0,0 @@
-# -*- 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())