boto3-assist 0.23.0__py3-none-any.whl → 0.25.0__py3-none-any.whl

boto3_assist/dynamodb/dynamodb.py

@@ -352,7 +352,7 @@ class DynamoDB(DynamoDBConnection):
             if not index_name:
                 index_name = key.name
             # turn it into a key expected by dynamodb
-            key = key.key()
+            key = key.key(query_key=True)
 
         kwargs: dict = {}
 

boto3_assist/dynamodb/dynamodb_index.py

@@ -156,11 +156,22 @@ class DynamoDBIndex:
         condition: str = "begins_with",
         low_value: Any = None,
         high_value: Any = None,
+        query_key: bool = False,
         # sk_value_2: Optional[str | int | float] = None,
     ) -> dict | Key | ConditionBase | ComparisonCondition | Equals:
         """Get the key for a given index"""
         key: dict | Key | ConditionBase | ComparisonCondition | Equals
-        if (
+
+        if query_key:
+            key = self._build_query_key(
+                include_sort_key=include_sort_key,
+                condition=condition,
+                low_value=low_value,
+                high_value=high_value,
+            )
+            return key
+
+        elif (
             self.name == DynamoDBIndexes.PRIMARY_INDEX
             and include_sort_key
             # if it ends with a # we are assuming that we are doing a wild card mapping
@@ -175,14 +186,15 @@ class DynamoDBIndex:
                 key[self.sort_key.attribute_name] = self.sort_key.value
 
             return key
-        else:
-            key = self._build_query_key(
-                include_sort_key=include_sort_key,
-                condition=condition,
-                low_value=low_value,
-                high_value=high_value,
-            )
-            return key
+
+        # catch all (TODO: decide if this is the best pattern or should we raise an error)
+        key = self._build_query_key(
+            include_sort_key=include_sort_key,
+            condition=condition,
+            low_value=low_value,
+            high_value=high_value,
+        )
+        return key
 
     def _build_query_key(
         self,

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.23.0'
+__version__ = '0.25.0'

{boto3_assist-0.23.0.dist-info → boto3_assist-0.25.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.23.0
+Version: 0.25.0
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt
@@ -32,7 +32,7 @@ Description-Content-Type: text/markdown
 
 This is in beta and subject to changes before it's initial 1.0.0 release
 
-This libary was created to make life a little easier when using boto3.
+This library was created to make life a little easier when using boto3.
 
 Currently it supports:
 - User Authentication / Session Mapping
@@ -40,11 +40,11 @@ Currently it supports:
 
 
 ## User Authentication / Session Mapping
-Have you ever needed an easy way to load your sessions for a local, dev or production enviroment? Well this library
+Have you ever needed an easy way to load your sessions for a local, dev or production environment? Well this library
 makes it a little easier by lazy loading your boto3 session so that tools like `python-dotenv` can be used to load your
 environment vars first and then load your session.
 
-## DyamoDB model mapping and Key Generation
+## DynamoDB model mapping and Key Generation
 It's a light weight mapping tool to turn your python classes / object models to DynamoDB items that are ready
 for saving.  See the [examples](https://github.com/geekcafe/boto3-assist/tree/main/examples) directory in the repo for more information.
 
@@ -61,7 +61,7 @@ pip install boto3-assist
 ## Running Unit Tests
 Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  
 
-For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
+For your convenience the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.
 
 Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
 

{boto3_assist-0.23.0.dist-info → boto3_assist-0.25.0.dist-info}/RECORD

@@ -6,7 +6,7 @@ boto3_assist/connection_tracker.py,sha256=UgfR9RlvXf3A4ssMr3gDMpw89ka8mSRvJn4M34
 boto3_assist/http_status_codes.py,sha256=G0zRSWenwavYKETvDF9tNVUXQz3Ae2gXdBETYbjvJe8,3284
 boto3_assist/role_assumption_mixin.py,sha256=PMUU5yC2FUBjFD1UokVkRY3CPB5zTw85AhIB5BMtbc8,1031
 boto3_assist/session_setup_mixin.py,sha256=X-JQKyyaWNA8Z8kKgf2V2I5vsiLAH8udLTX_xepnsdQ,3140
-boto3_assist/version.py,sha256=pwluWaTPL8Xkb9G3PEN8_juXZgyuXodBFmQvwlw9pb4,23
+boto3_assist/version.py,sha256=ZXwoHOJ1nuRTdGrZbLNxvqbzWWkFvDkI3L0gzEDgw-w,23
 boto3_assist/aws_lambda/event_info.py,sha256=OkZ4WzuGaHEu_T8sB188KBgShAJhZpWASALKRGBOhMg,14648
 boto3_assist/aws_lambda/mock_context.py,sha256=LPjHP-3YSoY6iPl1kPqJDwSVf1zLNTcukUunDtYcbK0,116
 boto3_assist/cloudwatch/cloudwatch_connection.py,sha256=mnGWaLSQpHh5EeY7Ek_2o9JKHJxOELIYtQVMX1IaHn4,2480
@@ -19,11 +19,11 @@ boto3_assist/cognito/cognito_connection.py,sha256=deuXR3cNHz0mCYff2k0LfAvK--9Okq
 boto3_assist/cognito/cognito_utility.py,sha256=IVZAg58nHG1U7uxe7FsTYpqwwZiwwdIBGiVTZuLCFqg,18417
 boto3_assist/cognito/jwks_cache.py,sha256=1Y9r-YfQ8qrgZN5xYPvjUEEV0vthbdcPdAIaPbZP7kU,373
 boto3_assist/cognito/user.py,sha256=qc44qLx3gwq6q2zMxcPQze1EjeZwy5Kuav93vbe-4WU,820
-boto3_assist/dynamodb/dynamodb.py,sha256=aW6kWq-Hcc6idmuFygdpUyPusPHsIvVGq2hiG8n8gBo,18481
+boto3_assist/dynamodb/dynamodb.py,sha256=TiO1lnQGiWxaWZ5-nnaWMMThFl3PMkD2r5ApIxEhBC8,18495
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=D4KmVpMpE0OuVOwW5g4JBWllUNkwy0hMXEGUiToAMBc,3608
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=RoRRqKjdwfC-2-gvlkLvCoNWhIoMrHm-68dkyhXI_Xk,12080
 boto3_assist/dynamodb/dynamodb_importer.py,sha256=nCKsyRQeMqDSf0Q5mQ_X_oVIg4PRnu0hcUzZnBli610,3471
-boto3_assist/dynamodb/dynamodb_index.py,sha256=AOIeiWkJ3dgg21PJ2vADkR61l1AA6z5IYV3WtPYlvng,8734
+boto3_assist/dynamodb/dynamodb_index.py,sha256=EhLvaLQznrsbP1b8LRHDnPSUxou_JYn0fYYRLhvH26U,9085
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=O9Aj0PFEvcuk2vhARifWTFnUwcQW5EXzwZS478Hm-N0,796
 boto3_assist/dynamodb/dynamodb_key.py,sha256=4IYnG4a99AjdOKUcDaWhNF_lvZJRZcKOIPzBQQzVdB0,3294
 boto3_assist/dynamodb/dynamodb_model_base.py,sha256=Bgnjs62lHTqqJ2nZbPV1JHvcK6d2-aaRsJtcc8DEqKk,12291
@@ -57,8 +57,8 @@ boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
 boto3_assist/utilities/numbers_utility.py,sha256=wzv9d0uXT_2_ZHHio7LBzibwxPqhGpvbq9HinrVn_4A,10160
 boto3_assist/utilities/serialization_utility.py,sha256=Jc6H0cpcZjLO7tdyUZdBWHzItduLkw6sh2YQh8Hc8D8,21647
 boto3_assist/utilities/string_utility.py,sha256=XxUIz19L2LFFTRDAAmdPa8Qhn40u9yO7g4nULFuvg0M,11033
-boto3_assist-0.23.0.dist-info/METADATA,sha256=3Qv_kRRHYWhDr-E5jQG7qH7Y1lFy6-6qAIA8hALdMJI,2875
-boto3_assist-0.23.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-boto3_assist-0.23.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.23.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.23.0.dist-info/RECORD,,
+boto3_assist-0.25.0.dist-info/METADATA,sha256=OMCf1gbVokM0aOSksJTPEPXmoCP6KCWVfLA7MOQS0AM,2879
+boto3_assist-0.25.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+boto3_assist-0.25.0.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.25.0.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.25.0.dist-info/RECORD,,