Incorporate notebook tests (#53)

This PR introduces Jupyter notebook tests using the `treon` framework:
https://github.com/ReviewNB/treon

To run notebook tests:
```
treon docs/ -v
```

Co-authored-by: Sam Partee <sam.partee@redis.com>

Author: tylerhutcherson

.github/workflows/run_tests.yml

@@ -40,6 +40,11 @@ jobs:
         OPENAI_API_KEY: ${{ secrets.OPENAI_KEY }}
       run: |
         make test-cov
+    - name: Run notebooks
+      env:
+        OPENAI_API_KEY: ${{ secrets.OPENAI_KEY }}
+      run: |
+        cd docs/ && treon -v --exclude="./examples/openai_qna.ipynb"
     - name: Publish coverage results
       uses: codecov/codecov-action@v2
       with:

.gitignore

@@ -4,4 +4,5 @@ redisvl.egg-info/
 .coverage
 scratch
 .DS_Store
-*.csv
+*.csv
+wiki_schema.yaml

docs/examples/openai_qna.ipynb

@@ -849,7 +849,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.9.12"
   },
   "orig_nbformat": 4
  },

docs/user_guide/hybrid_queries_02.ipynb

@@ -697,7 +697,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.10"
   },
   "orig_nbformat": 4,
   "vscode": {

docs/user_guide/llmcache_03.ipynb

@@ -29,9 +29,8 @@
     "import getpass\n",
     "os.environ[\"TOKENIZERS_PARALLELISM\"] = \"False\"\n",
     "\n",
-    "api_key = os.getenv(\"OPENAI_API_KEY\", None)\n",
-    "if not api_key:\n",
-    "  api_key = getpass.getpass(\"Enter your OpenAI API key: \")\n",
+    "\n",
+    "api_key = os.getenv(\"OPENAI_API_KEY\") or getpass.getpass(\"Enter your OpenAI API key: \")\n",
     "\n",
     "openai.api_key = api_key\n",
     "\n",
@@ -377,7 +376,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.10"
   },
   "orig_nbformat": 4
  },

docs/user_guide/vectorizers_03.ipynb

@@ -69,9 +69,7 @@
     "import getpass\n",
     "\n",
     "# setup the API Key\n",
-    "api_key = os.environ.get(\"OPENAI_API_KEY\")\n",
-    "if not api_key:\n",
-    "    api_key = getpass.getpass(\"Enter your OpenAI API key: \")"
+    "api_key = os.environ.get(\"OPENAI_API_KEY\") or getpass.getpass(\"Enter your OpenAI API key: \")"
    ]
   },
   {
@@ -379,7 +377,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.10"
   },
   "orig_nbformat": 4,
   "vscode": {

requirements-dev.txt

@@ -7,4 +7,5 @@ pytest-asyncio
 mypy
 types-redis
 types-pyyaml
-types-tabulate
+types-tabulate
+treon