Skip to main content

Utility toolkit for omnibenchmark modules and Snakemake workflows

Project description

obkit

Utility toolkit for omnibenchmark modules and Snakemake workflows. Pure stdlib, zero runtime dependencies.

The R implementation lives in the same repository under r/obkit.

Install

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

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 for the record schema.

Status

v0.1, pre-release. Wire format is stable; API may still shift.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obkit-0.0.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obkit-0.0.1-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file obkit-0.0.1.tar.gz.

File metadata

  • Download URL: obkit-0.0.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for obkit-0.0.1.tar.gz
Algorithm Hash digest
SHA256 d84e4ca4d5a343bdecef8815f78d8be7b27756d72921e86891af8a60f2a20b36
MD5 bf7f32074b7de9f5688166dfa1e973c0
BLAKE2b-256 d56e105c8cfdcb78c9c75c314e8fb8f3fd929f2f95d29c89090d8096f33d5cbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for obkit-0.0.1.tar.gz:

Publisher: release.yml on omnibenchmark/obkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file obkit-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: obkit-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for obkit-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a936a5eef9d8af13261fb6d2ab37c2bcb63a0d37ce5cd0e73bce6d9916bb093
MD5 f55dad20c4fa06b83c0599414e039d34
BLAKE2b-256 b5156a421b2dab47c8b371f0f367c3a09de1a95b484f0ec7bbe0caed6d3962f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for obkit-0.0.1-py3-none-any.whl:

Publisher: release.yml on omnibenchmark/obkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page