obkit 0.0.1__py3-none-any.whl

obkit/logger/__init__.py

@@ -0,0 +1,63 @@
+import json
+import os
+import socket
+import sys
+from datetime import datetime, timezone
+
+_state = {
+    "log_file": None,
+    "warned_uninit": False,
+}
+
+
+def init_logger(path):
+    if not isinstance(path, str) or not path:
+        raise ValueError("init_logger(): 'path' must be a non-empty string")
+    os.makedirs(path, exist_ok=True)
+    log_file = os.path.join(os.path.realpath(path), "omnibench-events.jsonl")
+    _state["log_file"] = log_file
+    _state["warned_uninit"] = False
+    return log_file
+
+
+def _iso_ts():
+    now = datetime.now(timezone.utc)
+    return now.strftime("%Y-%m-%dT%H:%M:%S.") + f"{now.microsecond // 1000:03d}Z"
+
+
+def emit(event, phase, attrs=None):
+    if not isinstance(event, str) or not event:
+        raise ValueError("emit(): 'event' must be a non-empty string")
+    if phase not in ("start", "end"):
+        raise ValueError('emit(): \'phase\' must be "start" or "end"')
+
+    log_file = _state["log_file"]
+    if log_file is None:
+        if not _state["warned_uninit"]:
+            print(
+                "obkit: emit() called before init_logger(); events discarded.",
+                file=sys.stderr,
+            )
+            _state["warned_uninit"] = True
+        return False
+
+    rec = {
+        "ts": _iso_ts(),
+        "event": event,
+        "phase": phase,
+        "pid": os.getpid(),
+        "host": socket.gethostname(),
+    }
+    if attrs is not None:
+        if not isinstance(attrs, dict):
+            raise ValueError("emit(): 'attrs' must be a dict")
+        rec["attrs"] = attrs
+
+    try:
+        line = json.dumps(rec, separators=(",", ":"))
+        with open(log_file, "a", encoding="utf-8") as f:
+            f.write(line + "\n")
+        return True
+    except Exception as e:
+        print(f"obkit: emit() write failed: {e}", file=sys.stderr)
+        return False

obkit/prof/__init__.py

@@ -0,0 +1,2 @@
+# prof — parse and align profiling outputs (denet, Snakemake bench files)
+# with logger events for per-phase resource attribution.

obkit-0.0.1.dist-info/METADATA

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: obkit
+Version: 0.0.1
+Summary: Utility toolkit for omnibenchmark modules and Snakemake workflows
+Author: Omnibenchmark Contributors
+License: MIT License
+        
+        Copyright (c) 2026 Omnibenchmark Contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://omnibenchmark.org
+Project-URL: Repository, https://github.com/omnibenchmark/obkit
+Project-URL: Issues, https://github.com/omnibenchmark/obkit/issues
+Keywords: omnibenchmark,snakemake,benchmarking,logging,profiling
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: System :: Logging
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# obkit
+
+Utility toolkit for [omnibenchmark](https://omnibenchmark.org) modules and
+Snakemake workflows. Pure stdlib, zero runtime dependencies.
+
+The R implementation lives in the same repository under `r/obkit`.
+
+## Install
+
+```bash
+pip install obkit
+```
+
+## Modules
+
+| module        | purpose |
+|---------------|---------|
+| `obkit.logger` | Structured JSONL lifecycle event logging — drop phase-boundary anchors into a log file so downstream tooling can attribute profiler samples to named phases of a rule. |
+| `obkit.prof`   | Parse and align profiler output (denet, Snakemake bench files) with logger events for per-phase resource attribution. *(in progress)* |
+
+## Usage
+
+```python
+from obkit.logger import init_logger, emit
+
+init_logger("/path/to/logdir")
+emit("align", "start")
+# ... do work ...
+emit("align", "end", attrs={"reads": 12345})
+```
+
+Events are written to `omnibench-events.jsonl` inside the directory passed to
+`init_logger`. See the [wire format spec](https://github.com/omnibenchmark/obkit/blob/main/docs/spec-logger.md)
+for the record schema.
+
+## Status
+
+v0.1, pre-release. Wire format is stable; API may still shift.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

obkit-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+obkit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+obkit/logger/__init__.py,sha256=9ExDkAaJJAvjyTAq61jFJTQbDPEjyz_CYo4UNoaCe3Q,1821
+obkit/prof/__init__.py,sha256=4pGgvh2ADjrrTNdH413Z5TQJvbwjhnWYsfXeSUEvMXY,133
+obkit-0.0.1.dist-info/licenses/LICENSE,sha256=KYG7nDC4AIYT_mPatOTcJkxehjqMy49J8EopFNTLEmo,1083
+obkit-0.0.1.dist-info/METADATA,sha256=joOgvRDMSGZrHsIYFimCcRGQUy2O9VCkxnk2o4u4-7g,3770
+obkit-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+obkit-0.0.1.dist-info/top_level.txt,sha256=V7XLMpBruFPihHCZvjhMZmcJ6A27RpM-Tbv6iyvuft4,6
+obkit-0.0.1.dist-info/RECORD,,

obkit-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

obkit-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Omnibenchmark Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

obkit-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+obkit