zerobench 0.1__tar.gz

zerobench-0.1/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: j178/prek-action@v1
+
+  test:
+    name: Run tests on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Build wheel
+        run: uv build --wheel
+
+      - name: Install project's wheel and dependencies
+        run: |
+          uv sync --locked --no-install-project
+          uv pip install dist/zerobench-*.whl
+
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          pytest -v

zerobench-0.1/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Release to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    name: Publish package to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Check tag of last commit
+        run: |
+          echo "Current tag:"
+          git describe --tags --exact-match HEAD
+
+      - name: Clean uv cache for dynamic versioning
+        run: uv cache clean
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

zerobench-0.1/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+dist/
+build/
+/.venv/
+/.idea/
+
+*.py[cod]
+.ipynb_checkpoints/
+.DS_Store
+
+# Sphinx generated files
+docs/build/
+docs/source/api/generated/

zerobench-0.1/.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+- repo: https://github.com/asottile/pyupgrade
+  rev: "v3.21.2"
+  hooks:
+  - id: pyupgrade
+    args: ["--py310-plus"]
+
+- repo: https://github.com/hadialqattan/pycln
+  rev: "v2.6.0"
+  hooks:
+  - id: pycln
+    args:
+    - --all
+
+- repo: https://github.com/PyCQA/isort
+  rev: '7.0.0'
+  hooks:
+  - id: isort
+    args:
+    - --profile=black
+    - --line-length=100
+
+- repo: https://github.com/psf/black
+  rev: '26.1.0'
+  hooks:
+  - id: black
+    args:
+    - --skip-string-normalization
+    - --line-length=100
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 'v6.0.0'
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-yaml
+  - id: double-quote-string-fixer
+  - id: check-merge-conflict
+  - id: debug-statements
+
+- repo: https://github.com/pycqa/flake8
+  rev: '7.3.0'
+  hooks:
+  - id: flake8
+    name: flake 8 (src)
+    args:
+    - --max-line-length=100
+    # E203 Whitespace before ':' (black incompatibility)
+    # E731 Do not assign a lambda expression, use a def
+    - --extend-ignore=E203,E731
+    files: ^.*\.py
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: 'v1.19.1'
+  hooks:
+  - id: mypy
+    additional_dependencies:
+    - jax
+    - polars
+    - matplotlib
+    args:
+    - --strict
+    - --show-error-codes
+    - --enable-error-code=ignore-without-code
+    - --allow-untyped-calls
+    files: ^zerobench\.py

zerobench-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pierre Chanial
+
+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.

zerobench-0.1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: zerobench
+Version: 0.1
+Summary: A multidimensional benchmarking library with minimal overhead
+Author: Pierre Chanial
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: polars
+Description-Content-Type: text/markdown
+
+# zerobench
+
+A Python benchmarking library with zero overhead, designed for multidimensional performance analysis.
+
+## Installation
+
+```bash
+pip install zerobench
+```
+
+## Usage
+
+```python
+from zerobench import Benchmark
+
+bench = Benchmark()
+
+for n in [100, 1000, 10000]:
+    data = list(range(n))
+    with bench(method='sum', n=n):
+        sum(data)
+    with bench(method='len', n=n):
+        len(data)
+```
+Output:
+```text
+method=sum, n=100: 0.579 us ± 2.38 ns (median ± std. dev. of 7 runs, 500000 loops each)
+method=len, n=100: 0.020 us ± 0.45 ns (median ± std. dev. of 7 runs, 20000000 loops each)
+method=sum, n=1000: 5.369 us ± 44.70 ns (median ± std. dev. of 7 runs, 50000 loops each)
+method=len, n=1000: 0.029 us ± 0.09 ns (median ± std. dev. of 7 runs, 10000000 loops each)
+method=sum, n=10000: 53.728 us ± 69.86 ns (median ± std. dev. of 7 runs, 5000 loops each)
+method=len, n=10000: 0.029 us ± 0.25 ns (median ± std. dev. of 7 runs, 10000000 loops each)
+```
+
+```text
+print(bench)
+┌────────┬────────┬─────────────────────────────────┐
+│ method ┆ n      ┆ execution_times                 │
+╞════════╪════════╪═════════════════════════════════╡
+│ sum    ┆ 100    ┆ [0.577805, 0.57815, … 0.581231… │
+│ len    ┆ 100    ┆ [0.019207, 0.019278, … 0.01958… │
+│ sum    ┆ 1_000  ┆ [5.417795, 5.33863, … 5.35146]  │
+│ len    ┆ 1_000  ┆ [0.028898, 0.030144, … 0.03007… │
+│ sum    ┆ 10_000 ┆ [53.743199, 53.664567, … 53.72… │
+│ len    ┆ 10_000 ┆ [0.028857, 0.028911, … 0.02942… │
+└────────┴────────┴─────────────────────────────────┘
+```
+
+## Features
+
+- **Context manager API**: Benchmark any code block with `with bench(...): ...`
+- **Multidimensional**: Tag benchmarks with arbitrary keyword arguments
+- **Zero overhead**: Code is passed directly to `timeit.Timer`, no wrapper function
+- **Auto-scaling**: Automatically determines the number of iterations for reliable measurements
+- **Multiple exports**: CSV, Parquet, Markdown
+- **Plotting**: Built-in visualization with matplotlib
+
+## Export and Visualization
+
+```python
+# Export results
+bench.write_csv('results.csv')
+bench.write_parquet('results.parquet')
+bench.write_markdown('results.md')
+
+# Plot results
+bench.plot()
+bench.write_plot('results.pdf')
+```
+
+## Configuration
+
+```python
+Benchmark(
+    repeat=7,                    # Number of measurement repetitions
+    min_duration_of_repeat=0.2,  # Minimum duration per repeat (seconds)
+    time_units='ns',             # Time units: 'ns', 'us', 'ms', 's'
+)
+```
+
+## License
+
+MIT

zerobench-0.1/README.md

@@ -0,0 +1,83 @@
+# zerobench
+
+A Python benchmarking library with zero overhead, designed for multidimensional performance analysis.
+
+## Installation
+
+```bash
+pip install zerobench
+```
+
+## Usage
+
+```python
+from zerobench import Benchmark
+
+bench = Benchmark()
+
+for n in [100, 1000, 10000]:
+    data = list(range(n))
+    with bench(method='sum', n=n):
+        sum(data)
+    with bench(method='len', n=n):
+        len(data)
+```
+Output:
+```text
+method=sum, n=100: 0.579 us ± 2.38 ns (median ± std. dev. of 7 runs, 500000 loops each)
+method=len, n=100: 0.020 us ± 0.45 ns (median ± std. dev. of 7 runs, 20000000 loops each)
+method=sum, n=1000: 5.369 us ± 44.70 ns (median ± std. dev. of 7 runs, 50000 loops each)
+method=len, n=1000: 0.029 us ± 0.09 ns (median ± std. dev. of 7 runs, 10000000 loops each)
+method=sum, n=10000: 53.728 us ± 69.86 ns (median ± std. dev. of 7 runs, 5000 loops each)
+method=len, n=10000: 0.029 us ± 0.25 ns (median ± std. dev. of 7 runs, 10000000 loops each)
+```
+
+```text
+print(bench)
+┌────────┬────────┬─────────────────────────────────┐
+│ method ┆ n      ┆ execution_times                 │
+╞════════╪════════╪═════════════════════════════════╡
+│ sum    ┆ 100    ┆ [0.577805, 0.57815, … 0.581231… │
+│ len    ┆ 100    ┆ [0.019207, 0.019278, … 0.01958… │
+│ sum    ┆ 1_000  ┆ [5.417795, 5.33863, … 5.35146]  │
+│ len    ┆ 1_000  ┆ [0.028898, 0.030144, … 0.03007… │
+│ sum    ┆ 10_000 ┆ [53.743199, 53.664567, … 53.72… │
+│ len    ┆ 10_000 ┆ [0.028857, 0.028911, … 0.02942… │
+└────────┴────────┴─────────────────────────────────┘
+```
+
+## Features
+
+- **Context manager API**: Benchmark any code block with `with bench(...): ...`
+- **Multidimensional**: Tag benchmarks with arbitrary keyword arguments
+- **Zero overhead**: Code is passed directly to `timeit.Timer`, no wrapper function
+- **Auto-scaling**: Automatically determines the number of iterations for reliable measurements
+- **Multiple exports**: CSV, Parquet, Markdown
+- **Plotting**: Built-in visualization with matplotlib
+
+## Export and Visualization
+
+```python
+# Export results
+bench.write_csv('results.csv')
+bench.write_parquet('results.parquet')
+bench.write_markdown('results.md')
+
+# Plot results
+bench.plot()
+bench.write_plot('results.pdf')
+```
+
+## Configuration
+
+```python
+Benchmark(
+    repeat=7,                    # Number of measurement repetitions
+    min_duration_of_repeat=0.2,  # Minimum duration per repeat (seconds)
+    time_units='ns',             # Time units: 'ns', 'us', 'ms', 's'
+)
+```
+
+## License
+
+MIT

zerobench-0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "zerobench"
+dynamic = ['version']
+description = "A multidimensional benchmarking library with minimal overhead"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Pierre Chanial" }
+]
+dependencies = [
+    "matplotlib",
+    "polars",
+]
+
+[dependency-groups]
+dev = [
+    {include-group = 'docs'},
+    'pytest>=9.0',
+    'pytest-notebook>=0.10',
+]
+docs = [
+    'sphinx>=7.0.0',
+    'sphinx-rtd-theme>=1.3.0',
+    'myst-parser>=2.0.0',
+    'nbsphinx>=0.9.0',
+    'jupyter>=1.0.0',
+    'matplotlib>=3.7.0',
+    'numpy>=1.24.0',
+    'pillow>=9.0.0',
+]
+
+[tool.hatch.version]
+source = 'vcs'

zerobench-0.1/src/zerobench/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import version as _version
+
+from ._benchmark import Benchmark
+
+__all__ = ['Benchmark']
+__version__ = _version('zerobench')