DOCSP-22882 Python Quick Start + Tutorials (#1206)

* add python sample apps

* add python to quick start

* add python to aws tut

* add python to azure tut

* add python gcp

* add kv step

* move comment

* query on encrypted field

* snake case + move var assignment

* missing + char in source constant

* add local key file comments

Author: biniona-mongodb

source/core/queryable-encryption/quick-start.txt

@@ -59,6 +59,11 @@ Before You Get Started
 
          `Complete Node.js Application <{+sample-app-url-qe+}node-fle-2/local/reader/>`__
 
+      .. tab:: Python
+         :tabid: python
+
+         `Complete Python Application <{+sample-app-url-qe+}python-fle-2/local/reader/>`__
+
 
 .. tabs-selector:: drivers
 
@@ -90,6 +95,12 @@ Procedure
                To view the complete code for making a {+dek-long+}, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/local/reader/make_data_key.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+dek-long+}, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/local/reader/make_data_key.py>`__.
+
    .. step:: Configure your MongoClient for Encrypted Reads and Writes
 
       .. include:: /includes/queryable-encryption/quick-start/client.rst
@@ -108,6 +119,13 @@ Procedure
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/local/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for inserting an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/local/reader/insert_encrypted_document.py>`__.
+
+
    .. step:: Retrieve Your Encrypted Document
 
       .. include:: /includes/queryable-encryption/quick-start/find.rst
@@ -122,6 +140,12 @@ Procedure
                To view the complete code for finding an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/local/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/local/reader/insert_encrypted_document.py>`__.
+
 
 Learn More
 ----------

source/core/queryable-encryption/tutorials/aws/aws-automatic.txt

@@ -42,6 +42,11 @@ Before You Get Started
 
          `Complete Node.js Application <{+sample-app-url-qe+}node-fle-2/aws/reader/>`__
 
+      .. tab:: Python
+         :tabid: python
+
+         `Complete Python Application <{+sample-app-url-qe+}python-fle-2/aws/reader/>`__
+
 .. tabs-selector:: drivers
 
 Set Up the KMS
@@ -83,6 +88,12 @@ Create the Application
                To view the complete code for making a {+dek-long+}, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/aws/reader/make_data_key.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+dek-long+}, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/aws/reader/make_data_key.py>`__.
+
    .. step:: Configure your MongoClient for Encrypted Reads and Writes
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/aws/client.rst
@@ -101,6 +112,12 @@ Create the Application
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/aws/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for inserting an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/aws/reader/insert_encrypted_document.py>`__.
+
    .. step:: Retrieve Your Encrypted Document
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/aws/find.rst
@@ -115,6 +132,11 @@ Create the Application
                To view the complete code for finding an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/aws/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/aws/reader/insert_encrypted_document.py>`__.
 
 Learn More
 ----------

source/core/queryable-encryption/tutorials/azure/azure-automatic.txt

@@ -42,6 +42,11 @@ Before You Get Started
 
          `Complete Node.js Application <{+sample-app-url-qe+}node-fle-2/azure/reader/>`__
 
+      .. tab:: Python
+         :tabid: python
+
+         `Complete Python Application <{+sample-app-url-qe+}python-fle-2/azure/reader/>`__
+
 .. tabs-selector:: drivers
 
 Set Up the KMS
@@ -82,6 +87,12 @@ Create the Application
                To view the complete code for making a {+dek-long+}, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/azure/reader/make_data_key.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+dek-long+}, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/azure/reader/make_data_key.py>`__.
+
    .. step:: Configure your MongoClient for Encrypted Reads and Writes
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/azure/client.rst
@@ -100,6 +111,12 @@ Create the Application
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/azure/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for inserting an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/azure/reader/insert_encrypted_document.py>`__.
+
    .. step:: Retrieve Your Encrypted Document
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/azure/find.rst
@@ -114,6 +131,12 @@ Create the Application
                To view the complete code for finding an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/azure/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/azure/reader/insert_encrypted_document.py>`__.
+
 Learn More
 ----------
 

source/core/queryable-encryption/tutorials/gcp/gcp-automatic.txt

@@ -41,6 +41,11 @@ Before You Get Started
 
          `Complete Node.js Application <{+sample-app-url-qe+}node-fle-2/gcp/reader/>`__
 
+      .. tab:: Python
+         :tabid: python
+
+         `Complete Python Application <{+sample-app-url-qe+}python-fle-2/gcp/reader/>`__
+
 .. tabs-selector:: drivers
 
 Set Up the KMS
@@ -85,6 +90,12 @@ your application to see relevant code samples.
                To view the complete code for making a {+dek-long+}, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/gcp/reader/make_data_key.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for making a {+dek-long+}, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/gcp/reader/make_data_key.py>`__.
+
    .. step:: Configure your MongoClient for Encrypted Reads and Writes
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/gcp/client.rst
@@ -103,6 +114,12 @@ your application to see relevant code samples.
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/gcp/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for inserting an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/gcp/reader/insert_encrypted_document.py>`__.
+
    .. step:: Retrieve Your Encrypted Document
 
       .. include:: /includes/queryable-encryption/tutorials/automatic/gcp/find.rst
@@ -117,6 +134,12 @@ your application to see relevant code samples.
                To view the complete code for finding an encrypted document, see
                `our Github repository <{+sample-app-url-qe+}node-fle-2/gcp/reader/insert_encrypted_document.js>`__.
 
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url-qe+}python-fle-2/gcp/reader/insert_encrypted_document.py>`__.
+
 
 Learn More
 ----------

source/includes/queryable-encryption/quick-start/client.rst

@@ -20,6 +20,17 @@
                :dedent:
                :caption: insert_encrypted_document.js
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+               :start-after: start-key-vault
+               :end-before: end-key-vault
+               :language: python
+               :dedent:
+               :caption: insert_encrypted_document.py
+
+
    .. step:: Specify the Local {+cmk-long+}
 
       Specify the KMS provider and specify your key inline:
@@ -36,6 +47,15 @@
                :dedent:
                :caption: insert_encrypted_document.js
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+               :start-after: start-kmsproviders
+               :end-before: end-kmsproviders
+               :language: python
+               :dedent:
+               :caption: insert_encrypted_document.py
 
    .. step:: Create an {+enc-fields-map-title+} For Your Collection
 
@@ -53,6 +73,15 @@
                :dedent:
                :caption: insert_encrypted_document.js
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+               :start-after: start-schema
+               :end-before: end-schema
+               :language: python
+               :dedent:
+               :caption: insert_encrypted_document.py
 
    .. step:: Specify the Location of the {+shared-library+}
 
@@ -70,6 +99,16 @@
                :caption: insert_encrypted_document.js
                :dedent:
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+               :start-after: start-extra-options
+               :end-before: end-extra-options
+               :language: python
+               :dedent:
+               :caption: insert_encrypted_document.py
+
       .. include:: /includes/queryable-encryption/shared-lib-learn-more.rst
 
    .. step:: Create the MongoClient
@@ -88,3 +127,13 @@
                :language: javascript
                :dedent:
                :caption: insert_encrypted_document.js
+
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+               :start-after: start-client
+               :end-before: end-client
+               :language: python
+               :dedent:
+               :caption: insert_encrypted_document.py

source/includes/queryable-encryption/quick-start/dek.rst

@@ -27,6 +27,17 @@
                :language: javascript
                :dedent:
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/make_data_key.py
+               :start-after: start-kmsproviders
+               :end-before: end-kmsproviders
+               :language: python
+               :dedent:
+               :caption: make_data_key.py
+
+
    .. step:: Create your {+dek-long+}s
 
       .. _qe-local-create-dek:
@@ -55,6 +66,16 @@
                :dedent:
                :caption: make_data_key.js
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/make_data_key.py
+               :start-after: start-create-dek
+               :end-before: end-create-dek
+               :language: python
+               :dedent:
+               :caption: make_data_key.py
+
    .. step:: Create Your Encrypted Collection
 
       Use a {+qe+} enabled ``MongoClient`` instance to specify what
@@ -72,6 +93,16 @@
                :dedent:
                :caption: make_data_key.js
 
+         .. tab::
+            :tabid: python
+
+            .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/make_data_key.py
+               :start-after: start-create-enc-collection
+               :end-before: end-create-enc-collection
+               :language: python
+               :dedent:
+               :caption: make_data_key.py
+
 The output from the code in this section should resemble the following:
 
 .. literalinclude:: /includes/queryable-encryption/quick-start/dek-output.out

source/includes/queryable-encryption/quick-start/find.rst

@@ -18,6 +18,16 @@ a client that is not configured for automatic {+qe+}.
          :language: javascript
          :dedent:
 
+   .. tab::
+      :tabid: python
+
+      .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+         :start-after: start-find
+         :end-before: end-find
+         :language: python
+         :dedent:
+         :caption: insert_encrypted_document.py
+
 The output of the preceding code snippet should look like this:
 
 .. literalinclude:: /includes/queryable-encryption/quick-start/find-output.out

source/includes/queryable-encryption/quick-start/insert.rst

@@ -17,6 +17,16 @@ snippet:
          :dedent:
          :caption: insert_encrypted_document.js
 
+   .. tab::
+      :tabid: python
+
+      .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/insert_encrypted_document.py
+         :start-after: start-insert
+         :end-before: end-insert
+         :language: python
+         :dedent:
+         :caption: insert_encrypted_document.py
+
 When you insert a document, your {+qe+} enabled client
 encrypts the fields of your document such that it resembles the following:
 

source/includes/queryable-encryption/quick-start/key-vault-index.rst

@@ -14,3 +14,14 @@ Create a unique index on the ``keyAltNames`` field in your
          :caption: make_data_key.js
          :language: javascript
          :dedent:
+
+   .. tab::
+      :tabid: python
+
+      .. literalinclude:: /includes/queryable-encryption/sample_apps/build/python-fle-2/local/reader/make_data_key.py
+         :start-after: start-create-index
+         :end-before: end-create-index
+         :language: python
+         :dedent:
+         :caption: make_data_key.py
+