befordata-cli 0.1.0__tar.gz

befordata_cli-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.3
+Name: befordata-cli
+Version: 0.1.0
+Summary: Add your description here
+Author: Oliver Lindemann
+Author-email: Oliver Lindemann <lindemann@essb.eur.nl>
+Requires-Dist: befordata>=0.4.5
+Requires-Dist: icecream>=2.2.0
+Requires-Dist: pandas>=3.0.3
+Requires-Dist: pyxdf>=1.17.4
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+

befordata_cli-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "befordata-cli"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Oliver Lindemann", email = "lindemann@essb.eur.nl" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "befordata>=0.4.5",
+    "icecream>=2.2.0",
+    "pandas>=3.0.3",
+    "pyxdf>=1.17.4",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.15,<0.12.0"]
+build-backend = "uv_build"
+
+[project.scripts]
+befordata_cli = "befordata_cli.cli:run"

befordata_cli-0.1.0/src/befordata_cli/__init__.py

@@ -0,0 +1,8 @@
+"""Creating course manuals and tutor instruction with Quarto
+
+Oliver Lindemann
+"""
+
+__version__ = "0.1.0"
+__author__ = "Oliver Lindemann"
+

befordata_cli-0.1.0/src/befordata_cli/__main__.py

@@ -0,0 +1,4 @@
+from . import cli
+
+if __name__ == "__main__":
+    cli.run()

befordata_cli-0.1.0/src/befordata_cli/cli.py

@@ -0,0 +1,72 @@
+import argparse
+from os.path import isfile
+
+from befordata import xdf
+
+from . import __version__
+from .xdf import load_xdf, xdf_info
+
+
+def run() -> None:
+
+    parser = argparse.ArgumentParser(
+        prog="befordata_cli",
+        description="Command-line tool for befordata",
+    )
+    parser.add_argument(
+        "--version", action="version", version=f"%(prog)s {__version__}"
+    )
+
+    parser.add_argument("FILE", default="", help="data file")
+
+    parser.add_argument(
+        "-o", "--output",
+        metavar="dest",
+        help="Output file",
+    )
+    parser.add_argument(
+        "-i", "--info",
+        action="store_true",
+        default=False,
+        help="Print detailed stream info",
+    )
+    parser.add_argument(
+        "--arrow",
+        action="store_true",
+        default=False,
+        help="Convert file to Arrow format (.arrow)",
+    )
+    parser.add_argument(
+        "--csv",
+        action="store_true",
+        default=False,
+        help="Convert file to CSV format (.csv)",
+    )
+
+    args = parser.parse_args()
+
+    if len(args.FILE) < 2:
+        print("No data FILE specified.")
+        parser.print_help()
+        exit()
+
+
+    if not isfile(args.FILE):
+        print(f"File {args.FILE} does not exist.")
+
+    elif args.FILE.endswith(".xdf"):
+        xdf_info(args.FILE, info_dict=args.info)
+
+        if args.arrow or args.csv:
+            streams, header = load_xdf(args.FILE)
+            rec = xdf.before_record(streams, args.force_stream, 1000)
+
+            if args.arrow:
+                print(f"Converting to Arrow")
+
+            if args.csv:
+                print(f"Converting to CSV")
+
+
+if __name__ == "__main__":
+    run()

befordata_cli-0.1.0/src/befordata_cli/xdf.py

@@ -0,0 +1,24 @@
+from icecream import ic
+from pyxdf import load_xdf
+
+
+def xdf_info(filepath: str, info_dict:bool = False) -> tuple:
+    """
+    Extract metadata from an xdf file
+
+    Args:
+        filepath: path to the xdf file
+        info_dict: if True, return a dictionary containing the metadata extracted from the xdf file
+    Return:
+        metadata: dict containing the metadata extracted from the xdf file
+    """
+    data, header = load_xdf(filepath)
+    for stream in data:
+        n = len(stream['time_series'])
+        stream_time = stream['time_stamps'][-1] - stream['time_stamps'][0]
+        print(f"{stream['info']['name'][0]}: {n} samples, duration {stream_time:.2f} seconds")
+
+        if info_dict:
+           ic(stream['info'])
+    return data, header
+