boto3-assist 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

boto3_assist/connection_tracker.py

@@ -0,0 +1,47 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+
+class ConnectionTracker:
+    """
+    Tracks Connection Requests.
+    Useful in for performance tuning and debugging.
+    """
+
+    def __init__(self, service_name: str) -> None:
+        self.__connection_couter: int = 0
+        self.__service_name: str = service_name
+
+    def increment_connection(self) -> None:
+        """Increments the connection counter"""
+        self.__connection_couter += 1
+
+        if self.connection_count > 1:
+            self.__log_warning(
+                f"Your dynamodb connection count is {self.connection_count}. "
+                "Under most circumstances you should be able to use the same connection "
+                "vs. creating a new one.  Connections are expensive in terms of time / latency. "
+                "If you are seeing perforance issues, check how and where you are creating your "
+                "connections.  You should be able to pass the .db connection to your other objects "
+                "and reuse your dynamodb boto connections."
+            )
+
+    def decrement_connection(self) -> None:
+        """Decrements the connection counter"""
+        self.__connection_couter -= 1
+
+    @property
+    def connection_count(self) -> int:
+        """Returns the current connection count"""
+        return self.__connection_couter
+
+    def reset(self) -> None:
+        """Resets the connection counter"""
+        self.__connection_couter = 0
+
+    def __log_warning(self, message: str) -> None:
+        """Logs a warning message"""
+        print(f"Warning: {message}")

boto3_assist/dynamodb/dynamodb.py

@@ -372,6 +372,7 @@ class DynamoDB(DynamoDBConnection):
         do_projections: bool = False,
         ascending: bool = False,
         strongly_consistent: bool = False,
+        limit: Optional[int] = None,
     ) -> dict:
         """Helper function to list by criteria"""
 
@@ -391,6 +392,7 @@ class DynamoDB(DynamoDBConnection):
             expression_attribute_names=expression_attribute_names,
             ascending=ascending,
             strongly_consistent=strongly_consistent,
+            limit=limit,
         )
 
         return response

boto3_assist/dynamodb/dynamodb_model_base.py

@@ -130,6 +130,14 @@ class DynamoDBModelBase:
             self, include_indexes=include_indexes
         )
 
+    def to_dictionary(self):
+        """
+        Convert the instance to a dictionary without an indexes/keys.
+        Usefull for turning an object into a dictionary for serialization.
+        This is the same as to_resource_dictionary(include_indexes=False)
+        """
+        return DynamoDBSerializer.to_resource_dictionary(self, include_indexes=False)
+
     def get_key(self, index_name: str) -> DynamoDBIndex:
         """Get the index name and key"""
 

boto3_assist/ec2/ec2_connection.py

@@ -0,0 +1,103 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+from typing import Optional
+from typing import TYPE_CHECKING
+
+from aws_lambda_powertools import Logger
+from boto3_assist.boto3session import Boto3SessionManager
+from boto3_assist.environment_services.environment_variables import (
+    EnvironmentVariables,
+)
+from boto3_assist.connection_tracker import ConnectionTracker
+
+if TYPE_CHECKING:
+    from mypy_boto3_ec2 import Client
+else:
+    Client = object
+
+SERVICE_NAME = "ec2"
+logger = Logger()
+tracker: ConnectionTracker = ConnectionTracker(service_name=SERVICE_NAME)
+
+
+class EC2Connection:
+    """DB Environment"""
+
+    def __init__(
+        self,
+        *,
+        aws_profile: Optional[str] = None,
+        aws_region: Optional[str] = None,
+        aws_access_key_id: Optional[str] = None,
+        aws_secret_access_key: Optional[str] = None,
+    ) -> None:
+        self.aws_profile = aws_profile
+        self.aws_region = aws_region
+
+        self.aws_access_key_id = aws_access_key_id
+        self.aws_secret_access_key = aws_secret_access_key
+        self.__session: Boto3SessionManager | None = None
+        self.__client: Client | None = None
+
+        self.raise_on_error: bool = True
+
+    def setup(self, setup_source: Optional[str] = None) -> None:
+        """
+        Setup the environment.  Automatically called via init.
+        You can run setup at anytime with new parameters.
+        Args: setup_source: Optional[str] = None
+            Defines the source of the setup.  Useful for logging.
+        Returns: None
+        """
+
+        logger.info(
+            {
+                "metric_filter": "connection_setup",
+                "source": "setup",
+                "aws_profile": self.aws_profile,
+                "aws_region": self.aws_region,
+                "setup_source": setup_source,
+            }
+        )
+
+        # lazy load the session
+        self.__session = Boto3SessionManager(
+            service_name=SERVICE_NAME,
+            aws_profile=self.aws_profile,
+            aws_region=self.aws_region or EnvironmentVariables.AWS.region(),
+            aws_access_key_id=self.aws_access_key_id
+            or EnvironmentVariables.AWS.aws_access_key_id(),
+            aws_secret_access_key=self.aws_secret_access_key
+            or EnvironmentVariables.AWS.aws_secret_access_key(),
+        )
+
+        tracker.increment_connection()
+
+        self.raise_on_error = EnvironmentVariables.AWS.DynamoDB.raise_on_error_setting()
+
+    @property
+    def session(self) -> Boto3SessionManager:
+        """Session"""
+        if self.__session is None:
+            self.setup(setup_source="session init")
+        return self.__session
+
+    @property
+    def client(self) -> Client:
+        """Client Connection"""
+        if self.__client is None:
+            logger.info("Creating Client")
+            self.__client = self.session.client
+
+        if self.raise_on_error and self.__client is None:
+            raise RuntimeError("Client is not available")
+        return self.__client
+
+    @client.setter
+    def client(self, value: Client):
+        logger.info("Setting Client")
+        self.__client = value

boto3_assist/environment_services/environment_variables.py

@@ -83,6 +83,22 @@ class EnvironmentVariables:
             )
             return value
 
+        @staticmethod
+        def aws_access_key_id() -> str | None:
+            """
+            The aws_access_key_id.  Often used for local development.
+            """
+            value = os.getenv("ACCESS_KEY_ID")
+            return value
+
+        @staticmethod
+        def aws_secret_access_key() -> str | None:
+            """
+            The aws_secret_access_key.  Often used for local development.
+            """
+            value = os.getenv("SECRET_ACCESS_KEY")
+            return value
+
         class SES:
             """SES Settings"""
 

boto3_assist/version.py

@@ -1 +1 @@
-__version__ = '0.1.2'
+__version__ = '0.1.4'

{boto3_assist-0.1.2.dist-info → boto3_assist-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.1.2
+Version: 0.1.4
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 License-File: LICENSE-EXPLAINED.txt

{boto3_assist-0.1.2.dist-info → boto3_assist-0.1.4.dist-info}/RECORD

@@ -1,7 +1,8 @@
 boto3_assist/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/boto3session.py,sha256=J20E2lkqJOaey4Ohi-xRe2xABj7QsA8DrggzK29-5es,6415
-boto3_assist/version.py,sha256=mdp2CftfqYbdKtP-eWv1z7rAUycYv6X1ntXSMUf8Kss,22
-boto3_assist/dynamodb/dynamodb.py,sha256=jU4R__5jjI1CmH9xVNUeU8PICD2dtbQ2CYUFKMRw0P0,14561
+boto3_assist/connection_tracker.py,sha256=k59-7CdEvo5Slab80wwYz65sE1-sxVP1-wpQhZZXBZo,1632
+boto3_assist/version.py,sha256=aBEbDvx4LMg8A1TJJR6dEHu8rQODVin528hLS_EDvuA,22
+boto3_assist/dynamodb/dynamodb.py,sha256=vV0HvFCESnVK6BcAfcrWsMsNxIIsctvDX_3xdzOVCT0,14623
 boto3_assist/dynamodb/dynamodb_connection.py,sha256=JMCmWOsMzy45rikGl3Z2xqlG2vUTEKSYqi6dpsfJ750,4418
 boto3_assist/dynamodb/dynamodb_connection_tracker.py,sha256=nTNQ99sIidDoLMhMbBju2umgLmcttsmnvmd_DMy_J9M,1582
 boto3_assist/dynamodb/dynamodb_helpers.py,sha256=ajpTJ5bJOm9PDgE2Zx9p2zkTRFV4xswqJRS81SOTn1s,12198
@@ -9,20 +10,21 @@ boto3_assist/dynamodb/dynamodb_importer.py,sha256=8SlT2W03Dvb3LIs6xqtzXP4IShyv65
 boto3_assist/dynamodb/dynamodb_index.py,sha256=LRQgSci222s-pU-JXgnaAoOa71ABX9h3uJPeCVPl1GE,6315
 boto3_assist/dynamodb/dynamodb_iservice.py,sha256=2AuaKxt7DUZbB-GpBBtPtPMpAlgZkumkAldm8vy7-sg,701
 boto3_assist/dynamodb/dynamodb_key.py,sha256=X3I3gUPx2T858vjRDi9SN8qn8ez5UJUo0vZiKBeeUWg,1776
-boto3_assist/dynamodb/dynamodb_model_base.py,sha256=B8E4D2btjcIJjpzDnULlQk5Ccp5Qp3vN8vRdUHlshns,10949
+boto3_assist/dynamodb/dynamodb_model_base.py,sha256=IIcqdMN1SMvaDAvN2x1j8FMUPyVp8SdH8Vai8Qr4Nfs,11308
 boto3_assist/dynamodb/dynamodb_model_base_interfaces.py,sha256=yT4zDRI8vP15WVOHnCvY3FsEy_QSIta5-bnUby70Xow,747
 boto3_assist/dynamodb/dynamodb_reindexer.py,sha256=_I-W7Ply-82fRHnhsRZuquRYxEIXubuWGq7E7B4Pa7I,6204
 boto3_assist/dynamodb/readme.md,sha256=wNMzdRwk0qRV0kE88UUYnJos3pEK0HNjEIVkq2PATf8,1490
 boto3_assist/dynamodb/troubleshooting.md,sha256=uGpBaBUt_MyzjzwFOLOe0udTgcvaOpiTFxfj7ilLNkM,136
+boto3_assist/ec2/ec2_connection.py,sha256=KN1AivKY6yYpx_AjmaA3aQUZtUwKIvWk4FO8OPq1aTY,3182
 boto3_assist/environment_services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/environment_services/environment_loader.py,sha256=aW-PvlNi8EuavKPXDAi5txLbJFVRkBpkFIgmnR0OWDw,1581
-boto3_assist/environment_services/environment_variables.py,sha256=x0TzoIyes4poy12xKb22pqa7Ym_nKtrfI2bcELjsHWA,6191
+boto3_assist/environment_services/environment_variables.py,sha256=29ujkcFdgVgDgTK_pcVkpcFofEOYTbMXYyRim5vLj-k,6691
 boto3_assist/utilities/datetime_utility.py,sha256=TbqGQkJDTahqvaZAIV550nhYnW1Bsq0Hdu3Go6P4RRs,10282
 boto3_assist/utilities/logging_utility.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 boto3_assist/utilities/serialization_utility.py,sha256=s_QQRIhtwIE7xN5nU13mNk2wtWyErBX_Sg7n0gbHj-M,4308
 boto3_assist/utilities/string_utility.py,sha256=w8l063UT3GE48tuJopETyZrjG4CgAzWkyDWMAYMg5Og,7432
-boto3_assist-0.1.2.dist-info/METADATA,sha256=m3h0jNmaoYo8ji85NGE8Bm5s6nss7Z8CsqyJMmBsf78,1804
-boto3_assist-0.1.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-boto3_assist-0.1.2.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
-boto3_assist-0.1.2.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
-boto3_assist-0.1.2.dist-info/RECORD,,
+boto3_assist-0.1.4.dist-info/METADATA,sha256=m0RXVLD_x6l3VwV3g_EaXvmpwnXfJgDVQNvbrfG0N3M,1804
+boto3_assist-0.1.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+boto3_assist-0.1.4.dist-info/licenses/LICENSE-EXPLAINED.txt,sha256=WFREvTpfTjPjDHpOLADxJpCKpIla3Ht87RUUGii4ODU,606
+boto3_assist-0.1.4.dist-info/licenses/LICENSE.txt,sha256=PXDhFWS5L5aOTkVhNvoitHKbAkgxqMI2uUPQyrnXGiI,1105
+boto3_assist-0.1.4.dist-info/RECORD,,