Metadata-Version: 2.4
Name: scitex-benchmark
Version: 0.1.0
Summary: Performance benchmarking, runtime monitoring, and profiling helpers — standalone module from the SciTeX ecosystem
Author-email: Yusuke Watanabe <ywatanabe@scitex.ai>
License-Expression: AGPL-3.0-only
Project-URL: Homepage, https://github.com/ywatanabe1989/scitex-benchmark
Project-URL: Repository, https://github.com/ywatanabe1989/scitex-benchmark
Project-URL: Documentation, https://scitex-benchmark.readthedocs.io
Keywords: scitex,benchmark,profiler,monitor,performance,psutil
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=2.0; extra == "docs"
Requires-Dist: myst-parser>=2.0; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=1.25; extra == "docs"
Provides-Extra: all
Requires-Dist: scitex-benchmark[dev]; extra == "all"
Requires-Dist: scitex-benchmark[docs]; extra == "all"
Dynamic: license-file

# scitex-benchmark

Performance benchmarking, runtime monitoring, and profiling helpers extracted from the [SciTeX](https://github.com/ywatanabe1989/scitex-python) ecosystem as a standalone package.

## Install

```bash
pip install scitex-benchmark
```

## API

```python
import scitex_benchmark as bm

# Benchmark suite — time/memory across input sizes
suite = bm.BenchmarkSuite("io")
suite.add_benchmark(my_func, gen_input, "name", sizes=["1MB", "10MB"])
results = suite.run()

# Runtime monitor — alerts when CPU/RAM/disk thresholds breached
monitor = bm.RuntimeMonitor(cpu_threshold=80, mem_threshold=90)
with monitor:
    long_running_job()

# Profiler — quick wall-clock + memory snapshot
with bm.Profiler() as p:
    work()
print(p.summary())
```

## Status

Standalone fork of `scitex.benchmark`. Only dep is `psutil`. The umbrella
package's `scitex.benchmark` import path is preserved via a `sys.modules`-alias
bridge. Convenience builders inside `benchmark.py` import `scitex.io`/`scitex.stats`
*lazily* if you opt in — without those installed they simply error out at
the call site, but the core API works without them.

## License

AGPL-3.0-only (see [LICENSE](./LICENSE)).
