Welcome to MiniBench’s documentation!¶

MiniBench provides a simple framework for benchmarking following the unittest module pattern.

You can install minibench with pip:

$ pip install minibench

Then, you just have to write a .bench.py file.

# fake.bench.py
from minibench import Benchmark

class FakeBenchmark(Benchmark):
    '''Fake benchmark'''
    def bench_fake(self):
        '''Run my bench'''
        # Do something

Then run it with the bench command

$ bench
>>> Fake benchmark (x5)
Run my bench ......................................... ✔ (0.1234s)

Contents:

Welcome to MiniBench’s documentation!¶

Indices and tables¶