Redis.io website examples

.github/workflows/doctests.yml

@@ -0,0 +1,42 @@
+name: Documentation Tests
+
+on:
+  push:
+  pull_request:
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  doctests:
+    runs-on: ubuntu-latest
+    services:
+      redis-stack:
+        image: redis/redis-stack-server:latest
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: 'pip'
+      - run: |
+          sudo apt update
+          sudo apt install -y redis-tools
+      - name: lint check
+        run: |
+          pip install -r dev_requirements.txt
+          pip install -r requirements.txt
+          isort --check-only --diff doctests/*.py
+          black -l 80 --target-version py39 --check --diff doctests/*.py
+
+      - name: run tests
+        run: |
+          python setup.py build
+          python setup.py install
+          sh doctests/run_examples.sh

doctests/README.md

@@ -0,0 +1,31 @@
+# Command examples for redis.io
+
+## How to add an example
+
+Create regular python file in the current folder with meaningful name. It makes sense prefix example files with 
+command category (e.g. string, set, list, hash, etc) to make navigation in the folder easier. Files ending in *.py* 
+are automatically run by the test suite.
+
+### Special markup
+
+See https://github.com/redis-stack/redis-stack-website#readme for more details.
+
+## How to test examples
+
+Examples are standalone python scripts, committed to the *doctests* directory. These scripts assume that the
+```requirements.txt``` and ```dev_requirements.txt``` from this repository have been installed, as per below.
+
+```bash
+pip install requirements.txt
+pip install dev_requirements.txt
+```
+
+Note - the CI process, runs the basic ```black``` and ```isort``` linters against the examples. Assuming 
+the requirements above have been installed you can run ```black yourfile.py``` and ```isort yourfile.py``` 
+locally to validate the linting, prior to CI.
+
+Just include necessary assertions in the example file and run
+```bash
+sh doctests/run_examples.sh
+```
+to test all examples in the current folder.

doctests/run_examples.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+
+basepath=`readlink -f $1`
+if [ $? -ne 0 ]; then
+basepath=`readlink -f $(dirname $0)`
+fi
+echo "No path specified, using ${basepath}"
+
+set -e
+cd ${basepath}
+for i in `ls ${basepath}/*.py`; do
+    redis-cli flushdb
+    python $i
+done