jupyter-analysis-tools 1.4.3__py3-none-any.whl → 1.5.0__py3-none-any.whl

jupyter_analysis_tools/__init__.py

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

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.3.dist-info → jupyter_analysis_tools-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jupyter-analysis-tools
-Version: 1.4.3
+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.3)
+# 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.3.svg)](https://github.com/BAMresearch/jupyter-analysis-tools/compare/v1.4.3...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,20 @@ 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

{jupyter_analysis_tools-1.4.3.dist-info → jupyter_analysis_tools-1.5.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-jupyter_analysis_tools/__init__.py,sha256=ZWwqIRGKVRxOwNMzr6UyicWL5Y9elQGg373dGP1Mq08,398
+jupyter_analysis_tools/__init__.py,sha256=pMggtuE9JrsDIZ3UOGmLXEXdyRderIVhaujYrL9INpA,398
 jupyter_analysis_tools/analysis.py,sha256=AiAvUO648f0PYXqLfal1kDH926neasE5c1RYFu9wtYg,1768
 jupyter_analysis_tools/binning.py,sha256=d6eXRC3IOnnJIF25OfEASyWedT71EX2nF7jAgGJ9suQ,14536
 jupyter_analysis_tools/datalocations.py,sha256=BakfiZOMcBwp-_DAn7l57lGWZmZGNnk0j73V75nLBUA,4322
@@ -6,11 +6,13 @@ jupyter_analysis_tools/distrib.py,sha256=uyh2jXDdXR6dfd36CAoE5_psoFF0bfA6l1wletP
 jupyter_analysis_tools/git.py,sha256=mqSk5nnAFrmk1_2KFuKVrDWOkRbGbAQOq2N1DfxhNpg,2216
 jupyter_analysis_tools/plotting.py,sha256=X5Orrwiof-9MuYMKDJEXIlIt0K6bQT6ktFFjXKIVApI,1962
 jupyter_analysis_tools/readdata.py,sha256=kHbGh7sp3lbpxuHASmCUVZsfH45JCIxMzgSnbq-Pgoo,6883
+jupyter_analysis_tools/ssfz2json.py,sha256=XNgXHsdsE3z0ezXOKMK__9w27M3Z7mQgJyVsrECPXKQ,2164
 jupyter_analysis_tools/utils.py,sha256=c8q2-0v7wEjJ_3w5YTZdjFSf-RP1gPUpMJpv5KUyilU,8800
 jupyter_analysis_tools/widgets.py,sha256=rA8qPvY9nS1OtykZwXtCTG29K-N_MYFVb5Aj8yK40_s,2996
-jupyter_analysis_tools-1.4.3.dist-info/licenses/AUTHORS.rst,sha256=-twUESsY0XqFQ0MIC0ylKhglNwL8lyHmGXriM3RF-2s,93
-jupyter_analysis_tools-1.4.3.dist-info/licenses/LICENSE,sha256=jRVl3hmCq0Qv1wifm-EelEKhFWecdoWdhcxSte4a1_c,1125
-jupyter_analysis_tools-1.4.3.dist-info/METADATA,sha256=mwfPFJK0SJL_HGSfjiLbtWfMclgyQufodabdsqhKgu0,44709
-jupyter_analysis_tools-1.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-jupyter_analysis_tools-1.4.3.dist-info/top_level.txt,sha256=ei_0x-BF85FLoJ_h67ySwDFowtqus_gI4_0GR466PEU,23
-jupyter_analysis_tools-1.4.3.dist-info/RECORD,,
+jupyter_analysis_tools-1.5.0.dist-info/licenses/AUTHORS.rst,sha256=-twUESsY0XqFQ0MIC0ylKhglNwL8lyHmGXriM3RF-2s,93
+jupyter_analysis_tools-1.5.0.dist-info/licenses/LICENSE,sha256=jRVl3hmCq0Qv1wifm-EelEKhFWecdoWdhcxSte4a1_c,1125
+jupyter_analysis_tools-1.5.0.dist-info/METADATA,sha256=EVEC90BcATb6v0HralLJp704TFf4uo7aP3n1_vY9W3o,45404
+jupyter_analysis_tools-1.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+jupyter_analysis_tools-1.5.0.dist-info/entry_points.txt,sha256=iE6cyOy_uqG7mFx1P0URcnx2euAAsV6GBH4nYWG6fVI,68
+jupyter_analysis_tools-1.5.0.dist-info/top_level.txt,sha256=ei_0x-BF85FLoJ_h67ySwDFowtqus_gI4_0GR466PEU,23
+jupyter_analysis_tools-1.5.0.dist-info/RECORD,,

jupyter_analysis_tools-1.5.0.dist-info/entry_points.txt

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