Metadata-Version: 2.1
Name: redisbench-admin
Version: 0.1.36
Summary: Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... ).
Author: filipecosta90
Author-email: filipecosta.90@gmail.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: GitPython (>=3.1.12,<4.0.0)
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: boto3 (>=1.13.24,<2.0.0)
Requires-Dist: humanize (>=2.4.0,<3.0.0)
Requires-Dist: jsonpath_ng (>=1.5.2,<2.0.0)
Requires-Dist: matplotlib (>=3.2.1,<4.0.0)
Requires-Dist: pandas (>=1.0.4,<2.0.0)
Requires-Dist: paramiko (>=2.7.2,<3.0.0)
Requires-Dist: py_cpuinfo (>=5.0.0,<6.0.0)
Requires-Dist: pysftp (>=0.2.9,<0.3.0)
Requires-Dist: python_terraform (>=0.10.1,<0.11.0)
Requires-Dist: redis (>=3.5.3,<4.0.0)
Requires-Dist: redis-py-cluster (>=2.1.0,<3.0.0)
Requires-Dist: redistimeseries (>=1.4.3,<2.0.0)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Requires-Dist: seaborn (>=0.10.1,<0.11.0)
Requires-Dist: toml (>=0.10.1,<0.11.0)
Requires-Dist: tqdm (>=4.46.1,<5.0.0)
Description-Content-Type: text/markdown

[![codecov](https://codecov.io/gh/filipecosta90/redisbench-admin/branch/master/graph/badge.svg)](https://codecov.io/gh/filipecosta90/redisbench-admin)
![Actions](https://github.com/filipecosta90/redisbench-admin/workflows/Run%20Tests/badge.svg?branch=master)
![Actions](https://badge.fury.io/py/redisbench-admin.svg)

# redisbench-admin

Redis benchmark run helper can help you with the following tasks:

- Setup and teardown of an Redis and Redis Modules DBs for benchmarking
- Management of benchmark data and specifications across different setups
- Running benchmarks and recording results
- Comparing performance results
- Exporting performance results in several formats (CSV, RedisTimeSeries, JSON)
- [SOON] Finding performance problems by attaching telemetry probes

Current supported benchmark tools:
- [redisgraph-database-benchmark](https://github.com/RedisGraph/graph-database-benchmark/tree/master/benchmark/redisgraph)
- [ftsb_redisearch](https://github.com/RediSearch/ftsb)

** future versions will also support redis-benchmark and memtier_benchmark.

## Installation

Installation is done using pip, the package installer for Python, in the following manner:

```bash
python3 -m pip install redisbench-admin
```

## Development

### Running tests

A simple test suite is provided, and can be run with:

```sh
$ poetry run pytest
```

## License

redisbench-admin is distributed under the BSD3 license - see [LICENSE](LICENSE)

