From 7d23974a62982d1b4b5586a648f8e7b17eccc6e5 Mon Sep 17 00:00:00 2001
From: Chayim <chayim@users.noreply.github.com>
Date: Wed, 19 Jan 2022 17:55:19 +0200
Subject: Documentation fixes: JSON Example, SSL Connection Examples, RTD
 version (#1887)

---
 docs/conf.py                                |  14 +-
 docs/examples/ssl_connection_examples.ipynb | 277 ++++++++++++++++++++++++++++
 docs/examples/ssl_connecton_examples.ipynb  | 277 ----------------------------
 docs/redismodules.rst                       |   2 +
 4 files changed, 289 insertions(+), 281 deletions(-)
 create mode 100644 docs/examples/ssl_connection_examples.ipynb
 delete mode 100644 docs/examples/ssl_connecton_examples.ipynb

diff --git a/docs/conf.py b/docs/conf.py
index 0f11442..b99e46c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -35,6 +35,12 @@ extensions = [
     "sphinx.ext.autosectionlabel",
 ]
 
+# AutosectionLabel settings.
+# Uses a <page>:<label> schema which doesn't work for duplicate sub-section
+# labels, so set max depth.
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth = 2
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -58,10 +64,10 @@ copyright = "2021, Redis Inc"
 # The short X.Y version.
 import redis
 
-version = ".".join(redis.__version__.split(".")[0:2])
-
-# The full version, including alpha/beta/rc tags.
-release = redis.__version__
+version = ".".join(redis.__version__.split(".")[0:3])
+release = version
+if version == "99.99.99":
+    release = "dev"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/docs/examples/ssl_connection_examples.ipynb b/docs/examples/ssl_connection_examples.ipynb
new file mode 100644
index 0000000..386e4af
--- /dev/null
+++ b/docs/examples/ssl_connection_examples.ipynb
@@ -0,0 +1,277 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# SSL Connection Examples"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connecting to a Redis instance via SSL."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import redis\n",
+    "\n",
+    "ssl_connection = redis.Redis(host='localhost', port=6666, ssl=True, ssl_cert_reqs=\"none\")\n",
+    "ssl_connection.ping()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connecting to a Redis instance via a URL string"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import redis\n",
+    "url_connection = redis.from_url(\"redis://localhost:6379?ssl_cert_reqs=none&decode_responses=True&health_check_interval=2\")\n",
+    "url_connection.ping()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connecting to a Redis instance via SSL, while specifying a self-signed SSL certificate."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import os\n",
+    "import redis\n",
+    "\n",
+    "ssl_certfile=\"some-certificate.pem\"\n",
+    "ssl_keyfile=\"some-key.pem\"\n",
+    "ssl_ca_certs=ssl_certfile\n",
+    "\n",
+    "ssl_cert_conn = redis.Redis(\n",
+    "    host=\"localhost\",\n",
+    "    port=6666,\n",
+    "    ssl=True,\n",
+    "    ssl_certfile=ssl_certfile,\n",
+    "    ssl_keyfile=ssl_keyfile,\n",
+    "    ssl_cert_reqs=\"required\",\n",
+    "    ssl_ca_certs=ssl_ca_certs,\n",
+    ")\n",
+    "ssl_cert_conn.ping()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connecting to a Redis instance via SSL, and validate the OCSP status of the certificate\n",
+    "\n",
+    "The redis package is design to be small, meaning extra libraries must be installed, in order to support OCSP stapling. As a result, first install redis via:\n",
+    "\n",
+    "*pip install redis[ocsp]*\n",
+    "\n",
+    "This will install cryptography, requests, and PyOpenSSL, none of which are generally required to use Redis."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "import os\n",
+    "import redis\n",
+    "\n",
+    "ssl_certfile=\"some-certificate.pem\"\n",
+    "ssl_keyfile=\"some-key.pem\"\n",
+    "ssl_ca_certs=ssl_certfile\n",
+    "\n",
+    "ssl_cert_conn = redis.Redis(\n",
+    "    host=\"localhost\",\n",
+    "    port=6666,\n",
+    "    ssl=True,\n",
+    "    ssl_certfile=ssl_certfile,\n",
+    "    ssl_keyfile=ssl_keyfile,\n",
+    "    ssl_cert_reqs=\"required\",\n",
+    "    ssl_validate_ocsp=True\n",
+    ")\n",
+    "ssl_cert_conn.ping()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connect via SSL, validate OCSP-stapled certificates\n",
+    "\n",
+    "The redis package is design to be small, meaning extra libraries must be installed, in order to support OCSP stapling. As a result, first install redis via:\n",
+    "\n",
+    "*pip install redis[ocsp]*\n",
+    "\n",
+    "This will install cryptography, requests, and PyOpenSSL, none of which are generally required to use Redis."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Using a custom SSL context and validating against an expected certificate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "True"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "import redis\n",
+    "import OpenSSL\n",
+    "\n",
+    "ssl_certfile=\"some-certificate.pem\"\n",
+    "ssl_keyfile=\"some-key.pem\"\n",
+    "ssl_ca_certs=ssl_certfile\n",
+    "ssl_expected_certificate = \"expected-ocsp-certificate.pem\"\n",
+    "\n",
+    "# PyOpenSSL is used only for the purpose of validating the ocsp\n",
+    "# stapled response\n",
+    "ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)\n",
+    "ctx.use_certificate_file=ssl_certfile\n",
+    "ctx.use_privatekey_file=ssl_keyfile\n",
+    "expected_certificate = open(ssl_expected_certificate, 'rb').read()\n",
+    "\n",
+    "ssl_cert_conn = redis.Redis(\n",
+    "    host=\"localhost\",\n",
+    "    port=6666,\n",
+    "    ssl=True,\n",
+    "    ssl_certfile=ssl_certfile,\n",
+    "    ssl_keyfile=ssl_keyfile,\n",
+    "    ssl_cert_reqs=\"required\",\n",
+    "    ssl_ocsp_context=ctx,\n",
+    "    ssl_ocsp_expected_cert=expected_certificate,\n",
+    ")\n",
+    "ssl_cert_conn.ping()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Naive validation of a stapled OCSP certificate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import redis\n",
+    "import OpenSSL\n",
+    "\n",
+    "ssl_certfile=\"some-certificate.pem\"\n",
+    "ssl_keyfile=\"some-key.pem\"\n",
+    "ssl_ca_certs=ssl_certfile\n",
+    "ssl_expected_certificate = \"expected-ocsp-certificate.pem\"\n",
+    "\n",
+    "# PyOpenSSL is used only for the purpose of validating the ocsp\n",
+    "# stapled response\n",
+    "ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)\n",
+    "ctx.use_certificate_file=ssl_certfile\n",
+    "ctx.use_privatekey_file=ssl_keyfile\n",
+    "\n",
+    "ssl_cert_conn = redis.Redis(\n",
+    "    host=\"localhost\",\n",
+    "    port=6666,\n",
+    "    ssl=True,\n",
+    "    ssl_certfile=ssl_certfile,\n",
+    "    ssl_keyfile=ssl_keyfile,\n",
+    "    ssl_cert_reqs=\"required\",\n",
+    "    ssl_validate_ocsp_stapled=True,\n",
+    ")\n",
+    "ssl_cert_conn.ping()"
+   ]
+  }
+ ],
+ "metadata": {
+  "interpreter": {
+   "hash": "d45c99ba0feda92868abafa8257cbb4709c97f1a0b5dc62bbeebdf89d4fad7fe"
+  },
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.8.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/docs/examples/ssl_connecton_examples.ipynb b/docs/examples/ssl_connecton_examples.ipynb
deleted file mode 100644
index 386e4af..0000000
--- a/docs/examples/ssl_connecton_examples.ipynb
+++ /dev/null
@@ -1,277 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# SSL Connection Examples"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Connecting to a Redis instance via SSL."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "import redis\n",
-    "\n",
-    "ssl_connection = redis.Redis(host='localhost', port=6666, ssl=True, ssl_cert_reqs=\"none\")\n",
-    "ssl_connection.ping()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Connecting to a Redis instance via a URL string"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import redis\n",
-    "url_connection = redis.from_url(\"redis://localhost:6379?ssl_cert_reqs=none&decode_responses=True&health_check_interval=2\")\n",
-    "url_connection.ping()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Connecting to a Redis instance via SSL, while specifying a self-signed SSL certificate."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "import os\n",
-    "import redis\n",
-    "\n",
-    "ssl_certfile=\"some-certificate.pem\"\n",
-    "ssl_keyfile=\"some-key.pem\"\n",
-    "ssl_ca_certs=ssl_certfile\n",
-    "\n",
-    "ssl_cert_conn = redis.Redis(\n",
-    "    host=\"localhost\",\n",
-    "    port=6666,\n",
-    "    ssl=True,\n",
-    "    ssl_certfile=ssl_certfile,\n",
-    "    ssl_keyfile=ssl_keyfile,\n",
-    "    ssl_cert_reqs=\"required\",\n",
-    "    ssl_ca_certs=ssl_ca_certs,\n",
-    ")\n",
-    "ssl_cert_conn.ping()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Connecting to a Redis instance via SSL, and validate the OCSP status of the certificate\n",
-    "\n",
-    "The redis package is design to be small, meaning extra libraries must be installed, in order to support OCSP stapling. As a result, first install redis via:\n",
-    "\n",
-    "*pip install redis[ocsp]*\n",
-    "\n",
-    "This will install cryptography, requests, and PyOpenSSL, none of which are generally required to use Redis."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "import os\n",
-    "import redis\n",
-    "\n",
-    "ssl_certfile=\"some-certificate.pem\"\n",
-    "ssl_keyfile=\"some-key.pem\"\n",
-    "ssl_ca_certs=ssl_certfile\n",
-    "\n",
-    "ssl_cert_conn = redis.Redis(\n",
-    "    host=\"localhost\",\n",
-    "    port=6666,\n",
-    "    ssl=True,\n",
-    "    ssl_certfile=ssl_certfile,\n",
-    "    ssl_keyfile=ssl_keyfile,\n",
-    "    ssl_cert_reqs=\"required\",\n",
-    "    ssl_validate_ocsp=True\n",
-    ")\n",
-    "ssl_cert_conn.ping()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Connect via SSL, validate OCSP-stapled certificates\n",
-    "\n",
-    "The redis package is design to be small, meaning extra libraries must be installed, in order to support OCSP stapling. As a result, first install redis via:\n",
-    "\n",
-    "*pip install redis[ocsp]*\n",
-    "\n",
-    "This will install cryptography, requests, and PyOpenSSL, none of which are generally required to use Redis."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Using a custom SSL context and validating against an expected certificate"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "True"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "import redis\n",
-    "import OpenSSL\n",
-    "\n",
-    "ssl_certfile=\"some-certificate.pem\"\n",
-    "ssl_keyfile=\"some-key.pem\"\n",
-    "ssl_ca_certs=ssl_certfile\n",
-    "ssl_expected_certificate = \"expected-ocsp-certificate.pem\"\n",
-    "\n",
-    "# PyOpenSSL is used only for the purpose of validating the ocsp\n",
-    "# stapled response\n",
-    "ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)\n",
-    "ctx.use_certificate_file=ssl_certfile\n",
-    "ctx.use_privatekey_file=ssl_keyfile\n",
-    "expected_certificate = open(ssl_expected_certificate, 'rb').read()\n",
-    "\n",
-    "ssl_cert_conn = redis.Redis(\n",
-    "    host=\"localhost\",\n",
-    "    port=6666,\n",
-    "    ssl=True,\n",
-    "    ssl_certfile=ssl_certfile,\n",
-    "    ssl_keyfile=ssl_keyfile,\n",
-    "    ssl_cert_reqs=\"required\",\n",
-    "    ssl_ocsp_context=ctx,\n",
-    "    ssl_ocsp_expected_cert=expected_certificate,\n",
-    ")\n",
-    "ssl_cert_conn.ping()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Naive validation of a stapled OCSP certificate"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import redis\n",
-    "import OpenSSL\n",
-    "\n",
-    "ssl_certfile=\"some-certificate.pem\"\n",
-    "ssl_keyfile=\"some-key.pem\"\n",
-    "ssl_ca_certs=ssl_certfile\n",
-    "ssl_expected_certificate = \"expected-ocsp-certificate.pem\"\n",
-    "\n",
-    "# PyOpenSSL is used only for the purpose of validating the ocsp\n",
-    "# stapled response\n",
-    "ctx = OpenSSL.SSL.Context(OpenSSL.SSL.SSLv23_METHOD)\n",
-    "ctx.use_certificate_file=ssl_certfile\n",
-    "ctx.use_privatekey_file=ssl_keyfile\n",
-    "\n",
-    "ssl_cert_conn = redis.Redis(\n",
-    "    host=\"localhost\",\n",
-    "    port=6666,\n",
-    "    ssl=True,\n",
-    "    ssl_certfile=ssl_certfile,\n",
-    "    ssl_keyfile=ssl_keyfile,\n",
-    "    ssl_cert_reqs=\"required\",\n",
-    "    ssl_validate_ocsp_stapled=True,\n",
-    ")\n",
-    "ssl_cert_conn.ping()"
-   ]
-  }
- ],
- "metadata": {
-  "interpreter": {
-   "hash": "d45c99ba0feda92868abafa8257cbb4709c97f1a0b5dc62bbeebdf89d4fad7fe"
-  },
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.8.12"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}
diff --git a/docs/redismodules.rst b/docs/redismodules.rst
index 07e756d..e4d36b1 100644
--- a/docs/redismodules.rst
+++ b/docs/redismodules.rst
@@ -110,6 +110,8 @@ These are the commands for interacting with the `RediSearch module <https://redi
 .. code-block:: python
 
     import redis
+    from redis.commands.search.field import TextField
+
     r = redis.Redis()
     r.ft().create_index(TextField("play", weight=5.0), TextField("ball"))
     print(r.ft().info())
-- 
cgit v1.2.1