boto3-assist 0.9.5__tar.gz → 0.11.0__tar.gz

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/.vscode/settings.json

@@ -1,6 +1,6 @@
 {
-    "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true,
+    "python.testing.pytestEnabled": true,
+    "python.testing.unittestEnabled": false,
     "python.testing.unittestArgs": [
         "-v",
         "-s",
@@ -24,7 +24,7 @@
     "[python]": {
         
         "editor.formatOnSave": true,        
-        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.defaultFormatter": "ms-python.black-formatter",
     },
     
 }

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.9.5
+Version: 0.11.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
 License-File: LICENSE.txt
-Classifier: License :: Other/Proprietary License
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development
 Requires-Python: >=3.10
 Requires-Dist: aws-lambda-powertools
 Requires-Dist: aws-xray-sdk
@@ -23,6 +26,10 @@ Description-Content-Type: text/markdown
 
 # boto3 assist
 
+[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)
+
 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.
@@ -51,3 +58,19 @@ 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.
+
+Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
+
+```toml
+[profile moto-mock-tests]
+region = us-east-1
+output = json
+aws_access_key_id = test
+aws_secret_access_key = test
+
+```
+

boto3_assist-0.11.0/README.md

@@ -0,0 +1,50 @@
+# boto3 assist
+
+[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)
+
+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.
+
+Currently it supports:
+- User Authentication / Session Mapping
+- DynamoDB model mapping and key generation.
+
+
+## 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
+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
+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.
+
+
+```sh
+python -m vevn .venv
+source ./.venv/bin/activate
+
+pip install --upgrade pip  
+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.
+
+Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:
+
+```toml
+[profile moto-mock-tests]
+region = us-east-1
+output = json
+aws_access_key_id = test
+aws_secret_access_key = test
+
+```
+

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/pyproject.toml

@@ -5,9 +5,13 @@ build-backend = "hatchling.build"
 [tool.hatch.build.targets.wheel]
 packages = ["src/boto3_assist"]
 
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
 [project]
 name = "boto3_assist"
-version = "0.9.5"
+version = "0.11.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }
@@ -17,8 +21,11 @@ readme = "README.md"
 requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",
-    "License :: Other/Proprietary License",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
     "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Topic :: Software Development"
 ]
 
 dependencies = [

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/requirements-dev.txt

@@ -19,4 +19,5 @@ pkginfo # occasionally we need to upgrade this or we can get upload errors when
 # the error may look like the following
 # ERROR    InvalidDistribution: Metadata is missing required fields: Name, Version.                                                
 #          Make sure the distribution includes the files where those fields are specified, and is using a supported                
-#          Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 2.3. 
+#          Metadata-Version: 1.0, 1.1, 1.2, 2.0, 2.1, 2.2, 2.3. 
+pytest

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/cloudwatch/cloudwatch_connection_tracker.py

@@ -14,4 +14,4 @@ class CloudWatchConnectionTracker(ConnectionTracker):
     """
 
     def __init__(self) -> None:
-        super().__init__("CloudWatch")
+        super().__init__()

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/cognito/cognito_utility.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import time
-from typing import List, Dict, Any, Optional
+from typing import List, Dict, Any, Optional, Literal
 
 
 from aws_lambda_powertools import Logger
@@ -130,7 +130,7 @@ class CognitoUtility(CognitoConnection):
                 is_permanent=True,
             )
 
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -185,7 +185,7 @@ class CognitoUtility(CognitoConnection):
             UserPoolId=user_pool_id, Username=user_name
         )
 
-        return response
+        return dict(response)
 
     def admin_enable_user(
         self, user_name: str, user_pool_id: str, reset_password: bool = True
@@ -271,7 +271,7 @@ class CognitoUtility(CognitoConnection):
             logger.debug(
                 f"User {email} created successfully. Confirmation code sent to {email}."
             )
-            return response
+            return dict(response)
 
         except self.client.exceptions.UsernameExistsException as e:
             logger.error(f"Error: {e.response['Error']['Message']}")
@@ -324,11 +324,11 @@ class CognitoUtility(CognitoConnection):
         user_pool_id,
         client_name,
         id_token_time_out=60,
-        id_token_units="minutes",
+        id_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         access_token_time_out=60,
-        access_token_units="minutes",
+        access_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
         refresh_token_time_out=60,
-        refresh_token_units="minutes",
+        refresh_token_units: Literal["days", "hours", "minutes", "seconds"] = "minutes",
     ) -> dict:
         # valid units: 'seconds'|'minutes'|'hours'|'days'
 
@@ -340,9 +340,9 @@ class CognitoUtility(CognitoConnection):
             AccessTokenValidity=access_token_time_out,
             IdTokenValidity=id_token_time_out,
             TokenValidityUnits={
-                "AccessToken": f"{access_token_units}",
-                "IdToken": f"{id_token_units}",
-                "RefreshToken": f"{refresh_token_units}",
+                "AccessToken": access_token_units,
+                "IdToken": id_token_units,
+                "RefreshToken": refresh_token_units,
             },
             # ReadAttributes=[
             #     'string',
@@ -381,18 +381,18 @@ class CognitoUtility(CognitoConnection):
             # AuthSessionValidity=123
         )
 
-        return response
+        return dict(response)
 
     def search_cognito(self, email: str, user_pool_id: str) -> dict:
         """Search cognito for an existing user"""
 
-        email = self.__format_email(email=email)
+        email = self.__format_email(email=email) or ""
         filter_string = f'email = "{email}"'
 
         # Call the admin_list_users method with the filter
         response = self.client.list_users(UserPoolId=user_pool_id, Filter=filter_string)
 
-        return response
+        return dict(response)
 
     def __set_user_attributes(self, *, user: CognitoUser) -> List[dict]:
         """

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import os
 from typing import List, Optional, overload, Dict, Any
 
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3.dynamodb.conditions import (
     Key,
     # And,
@@ -22,7 +22,7 @@ from boto3_assist.utilities.string_utility import StringUtility
 
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDB(DynamoDBConnection):
@@ -55,7 +55,7 @@ class DynamoDB(DynamoDBConnection):
         )
         logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
 
-    @tracer.capture_method
+    
     def save(
         self,
         item: dict | DynamoDBModelBase,
@@ -169,7 +169,7 @@ class DynamoDB(DynamoDBConnection):
         call_type: str = "resource",
     ) -> Dict[str, Any]: ...
 
-    @tracer.capture_method
+    
     def get(
         self,
         key: Optional[dict] = None,
@@ -344,7 +344,7 @@ class DynamoDB(DynamoDBConnection):
     ) -> dict:
         pass
 
-    @tracer.capture_method
+    
     def delete(
         self,
         *,

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/dynamodb/dynamodb_helpers.py

@@ -7,11 +7,11 @@ MIT License.  See Project Root for the license information.
 from typing import List, Any, Dict
 
 from boto3.dynamodb.conditions import ConditionBase, Key, And, Equals
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 
 logger = Logger()
-tracer = Tracer()
+
 
 
 class DynamoDBHelpers:
@@ -118,7 +118,7 @@ class DynamoDBHelpers:
             logger.error({"exception": str(e)})
             return "unknown"
 
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_response(self, items, dynamodb_response: dict, diagnostics) -> dict:
         """A wrapper for response data"""
         last_key = dynamodb_response.get("LastEvaluatedKey", None)
@@ -135,8 +135,7 @@ class DynamoDBHelpers:
         }
 
         return response
-
-    @tracer.capture_method(capture_response=False)
+    
     def wrap_collection_response(self, collection: List[dict]) -> dict[str, List]:
         """
         Wraps Up Some usefull information when dealing with

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -249,6 +249,7 @@ class DynamoDBModelBase(SerializableModel):
         """
 
         value = DatetimeUtility.to_datetime_utc(value)
+        return value
 
 
 class DynamoDBSerializer:

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/s3/s3_event_data.py

@@ -15,37 +15,37 @@ class EventData:
         self.__event = event
 
     @property
-    def version(self) -> str:
+    def version(self) -> str | None:
         """Event Version"""
         return self.__event.get("version")
 
     @property
-    def id(self) -> str:
+    def id(self) -> str | None:
         """Event Id"""
         return self.__event.get("id")
 
     @property
-    def detail_type(self) -> str:
+    def detail_type(self) -> str | None:
         """Event Detail Type"""
         return self.__event.get("detail-type")
 
     @property
-    def source(self) -> str:
+    def source(self) -> str | None:
         """Event Source"""
         return self.__event.get("source")
 
     @property
-    def account(self) -> str:
+    def account(self) -> str | None:
         """Event Account"""
         return self.__event.get("account")
 
     @property
-    def time(self) -> str:
+    def time(self) -> str | None:
         """Event Time"""
         return self.__event.get("time")
 
     @property
-    def region(self) -> str:
+    def region(self) -> str | None:
         """Event Region"""
         return self.__event.get("region")
 

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/s3/s3_object.py

@@ -217,7 +217,7 @@ class S3Object:
         )
         try:
             # convert if necessary
-            file_obj: bytes = (
+            file_obj = (
                 file_obj.encode("utf-8") if isinstance(file_obj, str) else file_obj
             )
             self.connection.client.upload_fileobj(
@@ -658,7 +658,7 @@ class S3Object:
             Key=destination_key,
         )
 
-        return response
+        return dict(response)
 
     def move(
         self,

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/securityhub/securityhub.py

@@ -5,7 +5,7 @@ MIT License.  See Project Root for the license information.
 """
 
 import os
-from typing import Optional
+from typing import Optional, Literal
 
 from aws_lambda_powertools import Logger
 
@@ -20,7 +20,7 @@ class SecurityHub(SecurityHubConnection):
     def update_findings_status(
         self,
         region_name: str,
-        workflow_status: str,
+        workflow_status: Literal["NEW", "NOTIFIED", "RESOLVED", "SUPPRESSED"],
         note_text: Optional[str] = None,
         updated_by: Optional[str] = None,
     ):

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/utilities/datetime_utility.py

@@ -8,11 +8,11 @@ import uuid
 from datetime import UTC, datetime, timedelta, timezone
 from typing import Any
 import pytz  # type: ignore
-from aws_lambda_powertools import Tracer, Logger
+from aws_lambda_powertools import Logger
 from dateutil.relativedelta import relativedelta
 
 
-tracer = Tracer()
+
 logger = Logger()
 
 _last_timestamp = None
@@ -47,7 +47,7 @@ class DatetimeUtility:
         return datetime.now(timezone.utc)
 
     @staticmethod
-    @tracer.capture_method(capture_response=False)
+    
     def string_to_date(string_date: str | datetime) -> datetime | None:
         """
         Description: takes a string value and returns it as a datetime.

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/utilities/serialization_utility.py

@@ -148,9 +148,11 @@ class JsonConversions:
         elif isinstance(data, list):
             # For lists, if deep conversion is enabled, process each element.
             return [
-                JsonConversions._convert_keys(item, convert_func, deep)
-                if deep
-                else item
+                (
+                    JsonConversions._convert_keys(item, convert_func, deep)
+                    if deep
+                    else item
+                )
                 for item in data
             ]
         else:
@@ -377,7 +379,10 @@ class Serialization:
             setattr(target, "__actively_serializing_data__", True)
 
         for key, value in source.items():
-            if Serialization.has_attribute(target, key):
+            if isinstance(target, dict):
+                # our target is a dictionary, so we need to handle this differently
+                target[key] = value
+            elif Serialization.has_attribute(target, key):
                 attr = getattr(target, key)
                 expected_type = type(attr)
 

{boto3_assist-0.9.5 → boto3_assist-0.11.0}/src/boto3_assist/utilities/string_utility.py

@@ -313,6 +313,7 @@ class StringUtility:
                 return True
             if value in ("false", "0", "f", "n", "no"):
                 return False
+            raise ValueError(f"Invalid boolean value: {value}")
         elif isinstance(value, int):
             return bool(value)
         elif value is None:

boto3_assist-0.11.0/src/boto3_assist/version.py

@@ -0,0 +1 @@
+__version__ = '0.11.0'

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dbmodels/cms/content_block.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
 from boto3_assist.utilities.string_utility import StringUtility
-from tests.dynamodb.models.cms.base import BaseCMSDBModel
+from tests.dynamodb_tests.models.cms.base import BaseCMSDBModel
 
 
 class ContentBlock(BaseCMSDBModel):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dbmodels/cms/page.py

@@ -7,7 +7,7 @@ MIT License.  See Project Root for the license information.
 from typing import List, Dict, Any
 import datetime as dt
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.dynamodb.dbmodels.cms.base import BaseCMSDBModel
+from tests.dynamodb_tests.dbmodels.cms.base import BaseCMSDBModel
 
 
 class Page(BaseCMSDBModel):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dbmodels/cms/template.py

@@ -6,7 +6,7 @@ MIT License.  See Project Root for the license information.
 
 from typing import List
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
-from tests.dynamodb.models.cms.base import BaseCMSDBModel
+from tests.dynamodb_tests.models.cms.base import BaseCMSDBModel
 
 
 class Template(BaseCMSDBModel):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dynamodb_model_base_test.py

@@ -9,7 +9,7 @@ from typing import Dict, List
 
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
 from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
-from tests.dynamodb.dbmodels.user_model import User
+from tests.dynamodb_tests.dbmodels.user_model import User
 
 
 class DynamoDBModelUnitTest(unittest.TestCase):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dynamodb_model_projections_test.py

@@ -7,8 +7,8 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.dynamodb.dbmodels.user_model import User
-from tests.dynamodb.dbmodels.simple_model import Simple
+from tests.dynamodb_tests.dbmodels.user_model import User
+from tests.dynamodb_tests.dbmodels.simple_model import Simple
 
 
 class DynamoDBModeProjectionlUnitTest(unittest.TestCase):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dynamodb_model_serializtion_test.py

@@ -7,8 +7,8 @@ MIT License.  See Project Root for the license information.
 import unittest
 
 
-from tests.dynamodb.dbmodels.user_model import User
-from tests.dynamodb.dbmodels.user_required_fields_model import User as User2
+from tests.dynamodb_tests.dbmodels.user_model import User
+from tests.dynamodb_tests.dbmodels.user_required_fields_model import User as User2
 
 
 class DynamoDBModelSerializationUnitTest(unittest.TestCase):

{boto3_assist-0.9.5/tests/dynamodb → boto3_assist-0.11.0/tests/dynamodb_tests}/dynamodb_moto_sorting_test.py

@@ -12,7 +12,7 @@ from mypy_boto3_dynamodb import DynamoDBClient
 
 from boto3_assist.dynamodb.dynamodb import DynamoDB
 from boto3_assist.environment_services.environment_loader import EnvironmentLoader
-from tests.dynamodb.dbmodels.cms.page import Page
+from tests.dynamodb_tests.dbmodels.cms.page import Page
 
 
 @moto.mock_aws
@@ -146,9 +146,7 @@ class DynamoDBSortinglUnitTest(unittest.TestCase):
                             "KeyType": "RANGE",
                         },  # Sort key for GSI
                     ],
-                    "Projection": {
-                        "ProjectionType": "ALL"  # Project all attributes
-                    },
+                    "Projection": {"ProjectionType": "ALL"},  # Project all attributes
                 }
             ],
             BillingMode="PAY_PER_REQUEST",

boto3_assist-0.11.0/tests/models_tests/models/person.py

@@ -0,0 +1,26 @@
+
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import List
+from boto3_assist.models.serializable_model import SerializableModel
+
+class Person(SerializableModel):
+    """A model that inherits the serializable"""
+
+    def __init__(self, name: str = "", age: int = 0, active: bool = False):
+        self.name = name
+        self.age = age
+        self.active = active
+        self.__pets: List[str] = []
+
+    @property
+    def pets(self) -> List[str]:
+        return self.__pets
+
+    @pets.setter
+    def pets(self, value: List[str]):
+        self.__pets = value

boto3_assist-0.11.0/tests/models_tests/models/user.py

@@ -0,0 +1,66 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Dict, Any
+from boto3_assist.models.serializable_model import SerializableModel
+
+
+class User(SerializableModel):
+    """A model that inherits the serializable"""
+
+    def __init__(self):
+        self.__first_name: str | None = None
+        self.__last_name: str | None = None
+        self.__email: str | None = None
+        self.__meta_data: Dict[str, Any] = {}
+        self.settings: Dict[str, Any] = {}
+
+    @property
+    def first_name(self) -> str | None:
+        """The first name of the user"""
+        if self.__first_name is None:
+            return None
+        return self.__first_name
+
+    @first_name.setter
+    def first_name(self, value: str | None):
+        self.__first_name = value
+
+    @property
+    def last_name(self) -> str | None:
+        """The last name of the user"""
+        if self.__last_name is None:
+            return None
+        return self.__last_name
+
+    @last_name.setter
+    def last_name(self, value: str | None):
+        self.__last_name = value
+
+    @property
+    def email(self) -> str | None:
+        """The email address of the user"""
+        if self.__email is None:
+            return None
+        return self.__email
+
+    @email.setter
+    def email(self, value: str | None):
+        self.__email = value
+
+    @property
+    def meta_data(self) -> Dict[str, Any]:
+        """The last name of the user"""
+        if self.__meta_data is None:
+            return {}
+        return self.__meta_data
+
+    @meta_data.setter
+    def meta_data(self, value: Dict[str, Any] | None):
+        if value is None:
+            self.__meta_data = {}
+            return
+        self.__meta_data = value