BenchMatcha

BenchMatcha is your companion pytest-like runner to google benchmarks. Analyze, plot, and save your results over time to evaluate regression over the lifetime of a project.

Table of Contents

• BenchMatcha
  • Installation
    • Install from pypi
    • Clone the repository
    • Pip install directly from github.
  • Development
  • For Developers
  • License

Installation

You have options.

Install from pypi

pip install BenchMatcha

Clone the repository

git clone https://github.com/Spill-Tea/BenchMatcha.git
cd BenchMatcha
pip install .

Pip install directly from github.

pip install git+https://github.com/Spill-Tea/BenchMatcha@main

Development

BenchMatcha is currently in the planning stages of development. This means the project is not ready for production use, and may be prone to change api without much notice.

For Developers

After cloning the repository, create a new virtual environment and run the following commands:

pip install -e ".[dev]"
pre-commit install
pre-commit run --all-files

Running unit tests locally is straightforward with tox. Make sure you have all python versions available required for your project The p flag is not required, but it runs tox environments in parallel.

tox -p

Be sure to run tox before creating a pull request.

License

BSD-3