m

Author: Lucas McDonald

DynamoDbEncryption/runtimes/python/README.md

@@ -1,12 +1,10 @@
 # Python AWS Database Encryption SDK for DynamoDB
 
 [![MPL-python-tests](https://github.com/aws/aws-database-encryption-sdk-dynamodb/actions/workflows/push.yml/badge.svg)](https://github.com/aws/aws-database-encryption-sdk-dynamodb/actions/workflows/push.yml)
-
 [![Code style: black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/ambv/black)
-
 [![Documentation Status](https://readthedocs.org/projects/aws-dbesdk-dynamodb-python/badge/)](https://aws-dbesdk-dynamodb-python.readthedocs.io/en/latest/)
 
-These are the docs for the Python AWS Database Encryption SDK for DynamoDB.
+Documentation for the Python AWS Database Encryption SDK for DynamoDB.
 
 The latest full documentation can be found at [Read the Docs](https://aws-dbesdk-dynamodb-python.readthedocs.io/en/latest/).
 

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/encrypted/client.py

@@ -44,23 +44,25 @@ class EncryptedClient(EncryptedBotoInterface):
     drop-in replacement that transparently handles encryption and decryption of items.
 
     The API matches the standard boto3 DynamoDB client interface:
+
     https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb.html#client
 
     This class will encrypt/decrypt items for the following operations:
-        * put_item
-        * get_item
-        * query
-        * scan
-        * batch_write_item
-        * batch_get_item
-        * transact_get_items
-        * transact_write_items
 
-    The update_item operation is not currently supported. Calling this operation will raise NotImplementedError.
+        * `put_item`
+        * `get_item`
+        * `query`
+        * `scan`
+        * `batch_write_item`
+        * `batch_get_item`
+        * `transact_get_items`
+        * `transact_write_items`
+
+    The `update_item` operation is not currently supported. Calling this operation will raise `NotImplementedError`.
 
     Any other operations on this class will defer to the underlying boto3 DynamoDB client's implementation.
 
-    EncryptedClient can also return an EncryptedPaginator for transparent decryption of paginated results.
+    `EncryptedClient` can also return an `EncryptedPaginator` for transparent decryption of paginated results.
     """
 
     _client: botocore.client.BaseClient
@@ -76,7 +78,7 @@ def __init__(
         expect_standard_dictionaries: bool | None = False,
     ):
         """
-        Create an EncryptedClient object.
+        Create an `EncryptedClient` object.
 
         Args:
             client (botocore.client.BaseClient): Initialized boto3 DynamoDB client
@@ -100,11 +102,12 @@ def put_item(self, **kwargs) -> dict[str, Any]:
         Put a single item to a table. Encrypts the item before writing to DynamoDB.
 
         The parameters and return value match the boto3 DynamoDB put_item API:
+
         https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/client/put_item.html
 
         Args:
             **kwargs: Keyword arguments to pass to the operation. These match the boto3 put_item API parameters.
-                The "Item" argument will be encrypted locally before being written to DynamoDB.
+            The "Item" argument will be encrypted locally before being written to DynamoDB.
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 put_item API response.
@@ -135,7 +138,7 @@ def get_item(self, **kwargs) -> dict[str, Any]:
 
         Returns:
             dict: The response from DynamoDB. This matches the boto3 get_item API response.
-                The "Item" field will be decrypted locally after being read from DynamoDB.
+            The "Item" field will be decrypted locally after being read from DynamoDB.
 
         """
         return self._client_operation_logic(