SimpleBench documentation

SimpleBench is a Python library for benchmarking and performance testing of code.

Note

This project is under active development and the API is still subject to change.

Contents

Table of Contents

• Installation
• Using SimpleBench
  • Examples
• Command-Line Options
  • General Options
  • Reporting Options
  • Report Types
    • Rich Table Reports
    • CSV Reports
    • Graph Reports
    • JSON Reports
• Reports
  • Rich Table Report
    • Report Variations and Destinations
    • Advanced Features
  • CSV Report
    • Report Variations and Destinations
    • Advanced Features
  • JSON Report
    • JSON Report Structure
    • Report Variations and Destinations
    • Advanced Features
  • Scatterplot Graph Report
    • Example Usage
    • Report Variations and Destinations
    • Advanced Features