[add] Added further documentation. Splitted actions in test/publish. Bump version (#19)

Author: filipecosta90

.github/workflows/poetry-pytest.yml

@@ -4,8 +4,6 @@ on:
   push:
     branches:
       - master
-  release:
-    types: [created, edited, published, prereleased]
 
 jobs:
   pytest:
@@ -46,9 +44,4 @@ jobs:
         run: poetry run pytest --cov redisbench_admin
 
       - name: Upload coverage
-        run: poetry run codecov -t ${{ secrets.CODECOV_TOKEN }}
-
-      - name: Publish to PyPI
-        if: github.event_name == 'release'
-        run: |
-          poetry publish -u __token__ -p ${{ secrets.PYPI_TOKEN }} --build
+        run: poetry run codecov -t ${{ secrets.CODECOV_TOKEN }}

.github/workflows/publish-pypi.yml

@@ -0,0 +1,41 @@
+name: Publish Pypi
+on:
+  release:
+    types: [published]
+
+jobs:
+  pytest:
+    name: pytest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+
+      - name: Install Poetry
+        uses: dschep/install-poetry-action@v1.3
+
+      - name: Cache Poetry virtualenv
+        uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/.virtualenvs
+          key: poetry-${{ hashFiles('**/poetry.lock') }}
+          restore-keys: |
+            poetry-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Set Poetry config
+        run: |
+          poetry config virtualenvs.in-project false
+          poetry config virtualenvs.path ~/.virtualenvs
+
+      - name: Install Dependencies
+        run: poetry install
+        if: steps.cache.outputs.cache-hit != 'true'
+
+      - name: Publish to PyPI
+        if: github.event_name == 'release'
+        run: |
+          poetry publish -u __token__ -p ${{ secrets.PYPI_TOKEN }} --build

README.md

@@ -3,7 +3,17 @@
 ![Actions](https://badge.fury.io/py/redisbench-admin.svg)
 
 # redisbench-admin
-Redis benchmark run helper. An automation wrapper around:
+
+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)
 
@@ -17,9 +27,7 @@ Installation is done using pip, the package installer for Python, in the followi
 python3 -m pip install redisbench-admin
 ```
 
-## Overview
-
-TBD
+## Development
 
 ### Running tests
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "redisbench-admin"
-version = "0.1.22"
+version = "0.1.23"
 description = "Redis benchmark run helper. A wrapper around Redis and Redis Modules benchmark tools ( ftsb_redisearch, memtier_benchmark, redis-benchmark, aibench, etc... )."
 authors = ["filipecosta90 <filipecosta.90@gmail.com>"]
 readme = "README.md"