| Name | BenchMatcha JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Google Benchmark Suite Runner and Regression Analyzer. |
| upload_time | 2025-08-31 17:55:50 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | BSD 3-Clause License
Copyright (c) 2025, Spill-Tea
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
benchmark
regression
analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
google-benchmark
numpy
orjson
plotly
pytest
scipy
toml
wurlitzer
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# BenchMatcha
[![build status][buildstatus-image]][buildstatus-url]
[buildstatus-image]: https://github.com/Spill-Tea/BenchMatcha/actions/workflows/python-app.yml/badge.svg?branch=main
[buildstatus-url]: https://github.com/Spill-Tea/BenchMatcha/actions?query=branch%3Amain
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.
<!-- omit in toc -->
## Table of Contents
- [BenchMatcha](#benchmatcha)
- [Installation](#installation)
- [Install from pypi](#install-from-pypi)
- [Clone the repository](#clone-the-repository)
- [Pip install directly from github.](#pip-install-directly-from-github)
- [Development](#development)
- [For Developers](#for-developers)
- [License](#license)
## Installation
You have options.
### Install from pypi
```bash
pip install BenchMatcha
```
### Clone the repository
```bash
git clone https://github.com/Spill-Tea/BenchMatcha.git
cd BenchMatcha
pip install .
```
### Pip install directly from github.
```bash
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:
```bash
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.
```bash
tox -p
```
Be sure to run tox before creating a pull request.
## License
[BSD-3](LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "BenchMatcha",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Jason C Del Rio <spillthetea917@gmail.com>",
"keywords": "benchmark, regression, analysis",
"author": null,
"author_email": "Jason C Del Rio <spillthetea917@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/ca/164bb8fe922c7416e22294e0099dd432aad430afa536c36cd1aa70f0f06c/benchmatcha-0.0.1.tar.gz",
"platform": null,
"description": "# BenchMatcha\n[![build status][buildstatus-image]][buildstatus-url]\n\n[buildstatus-image]: https://github.com/Spill-Tea/BenchMatcha/actions/workflows/python-app.yml/badge.svg?branch=main\n[buildstatus-url]: https://github.com/Spill-Tea/BenchMatcha/actions?query=branch%3Amain\n\n\n\nBenchMatcha is your companion pytest-like runner to google benchmarks.\nAnalyze, plot, and save your results over time to evaluate regression\nover the lifetime of a project.\n\n<!-- omit in toc -->\n## Table of Contents\n- [BenchMatcha](#benchmatcha)\n - [Installation](#installation)\n - [Install from pypi](#install-from-pypi)\n - [Clone the repository](#clone-the-repository)\n - [Pip install directly from github.](#pip-install-directly-from-github)\n - [Development](#development)\n - [For Developers](#for-developers)\n - [License](#license)\n\n\n## Installation\nYou have options.\n\n### Install from pypi\n```bash\npip install BenchMatcha\n```\n\n### Clone the repository\n```bash\ngit clone https://github.com/Spill-Tea/BenchMatcha.git\ncd BenchMatcha\npip install .\n```\n\n### Pip install directly from github.\n```bash\npip install git+https://github.com/Spill-Tea/BenchMatcha@main\n```\n\n## Development\n\nBenchMatcha is currently in the planning stages of development. This means the project\nis not ready for production use, and may be prone to change api without much notice.\n\n\n## For Developers\nAfter cloning the repository, create a new virtual environment and run the following\ncommands:\n\n```bash\npip install -e \".[dev]\"\npre-commit install\npre-commit run --all-files\n```\n\nRunning unit tests locally is straightforward with tox. Make sure\nyou have all python versions available required for your project\nThe `p` flag is not required, but it runs tox environments in parallel.\n```bash\ntox -p\n```\nBe sure to run tox before creating a pull request.\n\n## License\n[BSD-3](LICENSE)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, Spill-Tea\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Google Benchmark Suite Runner and Regression Analyzer.",
"version": "0.0.1",
"project_urls": {
"homepage": "https://github.com/Spill-Tea/BenchMatcha",
"issues": "https://github.com/Spill-Tea/BenchMatcha/issues"
},
"split_keywords": [
"benchmark",
" regression",
" analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "40dbf9b5b50ff226919c343c97c80f511fe9bf1e1e9f5b7332b1c6e50c527696",
"md5": "623eeca3b4d32d00ba6c4b50359bf58a",
"sha256": "3120e494e167b3e7a51927fae3e4892a80bc2404993bdae384b72ea839531be0"
},
"downloads": -1,
"filename": "benchmatcha-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "623eeca3b4d32d00ba6c4b50359bf58a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 27376,
"upload_time": "2025-08-31T17:55:49",
"upload_time_iso_8601": "2025-08-31T17:55:49.443744Z",
"url": "https://files.pythonhosted.org/packages/40/db/f9b5b50ff226919c343c97c80f511fe9bf1e1e9f5b7332b1c6e50c527696/benchmatcha-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4aca164bb8fe922c7416e22294e0099dd432aad430afa536c36cd1aa70f0f06c",
"md5": "e55f20c218c86b69562cf62f9fb4b1d3",
"sha256": "89d08d7ff75699a0f5783cf581a716965eeaec0959d286ebe7983fd76fc76b5c"
},
"downloads": -1,
"filename": "benchmatcha-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e55f20c218c86b69562cf62f9fb4b1d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 18823,
"upload_time": "2025-08-31T17:55:50",
"upload_time_iso_8601": "2025-08-31T17:55:50.731285Z",
"url": "https://files.pythonhosted.org/packages/4a/ca/164bb8fe922c7416e22294e0099dd432aad430afa536c36cd1aa70f0f06c/benchmatcha-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-31 17:55:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Spill-Tea",
"github_project": "BenchMatcha",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "google-benchmark",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "orjson",
"specs": []
},
{
"name": "plotly",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "toml",
"specs": []
},
{
"name": "wurlitzer",
"specs": []
}
],
"tox": true,
"lcname": "benchmatcha"
}
