Metadata-Version: 2.4
Name: obkit
Version: 0.0.3
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 `obkit-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).
