boto3-assist 0.1.2__tar.gz → 0.1.4__tar.gz

{boto3_assist-0.1.2 → boto3_assist-0.1.4}/PKG-INFO

@@ -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.4/aws_regions_with_status.csv

@@ -0,0 +1,31 @@
+RegionName,OptInStatus
+af-south-1,not-opted-in
+ap-east-1,not-opted-in
+ap-northeast-1,opt-in-not-required
+ap-northeast-2,opt-in-not-required
+ap-northeast-3,opt-in-not-required
+ap-south-1,opt-in-not-required
+ap-south-2,not-opted-in
+ap-southeast-1,opt-in-not-required
+ap-southeast-2,opt-in-not-required
+ap-southeast-3,not-opted-in
+ap-southeast-4,not-opted-in
+ap-southeast-5,not-opted-in
+ca-central-1,opt-in-not-required
+ca-west-1,not-opted-in
+eu-central-1,opt-in-not-required
+eu-central-2,not-opted-in
+eu-north-1,opt-in-not-required
+eu-south-1,not-opted-in
+eu-south-2,not-opted-in
+eu-west-1,opt-in-not-required
+eu-west-2,opt-in-not-required
+eu-west-3,opt-in-not-required
+il-central-1,not-opted-in
+me-central-1,not-opted-in
+me-south-1,not-opted-in
+sa-east-1,opt-in-not-required
+us-east-1,opt-in-not-required
+us-east-2,opt-in-not-required
+us-west-1,opt-in-not-required
+us-west-2,opt-in-not-required

boto3_assist-0.1.4/aws_regions_with_status.json

@@ -0,0 +1,122 @@
+[
+    {
+        "RegionName": "af-south-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ap-east-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ap-northeast-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-northeast-2",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-northeast-3",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-south-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-south-2",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ap-southeast-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-southeast-2",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ap-southeast-3",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ap-southeast-4",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ap-southeast-5",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "ca-central-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "ca-west-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "eu-central-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "eu-central-2",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "eu-north-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "eu-south-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "eu-south-2",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "eu-west-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "eu-west-2",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "eu-west-3",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "il-central-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "me-central-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "me-south-1",
+        "OptInStatus": "not-opted-in"
+    },
+    {
+        "RegionName": "sa-east-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "us-east-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "us-east-2",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "us-west-1",
+        "OptInStatus": "opt-in-not-required"
+    },
+    {
+        "RegionName": "us-west-2",
+        "OptInStatus": "opt-in-not-required"
+    }
+]

boto3_assist-0.1.4/examples/ec2/regions_report.py

@@ -0,0 +1,80 @@
+import os
+import json
+import csv
+from typing import List, Dict, Any
+from pathlib import Path
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.ec2.ec2_connection import EC2Connection
+
+
+class RegionsReport(EC2Connection):
+    def __init__(self) -> None:
+        super().__init__()
+
+    def get_aws_regions_with_status(self) -> List[Dict[str, Any]]:
+        """_summary_
+
+        Returns:
+            _type_: _description_
+        """
+        ec2 = self.client
+        regions = ec2.describe_regions(AllRegions=True)
+        # order by region name
+        regions["Regions"].sort(key=lambda x: x["RegionName"])
+        return [
+            {"RegionName": region["RegionName"], "OptInStatus": region["OptInStatus"]}
+            for region in regions["Regions"]
+        ]
+
+    def export(self, regions: List[Dict[str, Any]], file_format: str = "csv"):
+        """
+        Export the regions to a file
+        Args:
+            regions (List[Dict[str, Any]]): _description_
+            file_format (str, optional): _description_. Defaults to "csv".
+        """
+        if file_format == "csv":
+            self.__export_regions_to_csv(regions)
+        elif file_format == "json":
+            self.__export_regions_to_json(regions)
+
+    def __export_regions_to_csv(self, regions, filename="aws_regions_with_status.csv"):
+        with open(filename, "w", newline="", encoding="utf-8") as csvfile:
+            writer = csv.writer(csvfile)
+            writer.writerow(["RegionName", "OptInStatus"])
+            for region in regions:
+                writer.writerow([region["RegionName"], region["OptInStatus"]])
+
+    def __export_regions_to_json(
+        self, regions, filename="aws_regions_with_status.json"
+    ):
+        with open(filename, "w", encoding="utf-8") as jsonfile:
+            json.dump(regions, jsonfile, indent=4)
+
+
+def main():
+    """Main"""
+
+    env_file_name: str = os.getenv("ENVRIONMENT_FILE", ".env")
+    path = os.path.join(str(Path(__file__).parents[2].absolute()), env_file_name)
+    el: EnvironmentLoader = EnvironmentLoader()
+    if not os.path.exists(path=path):
+        raise FileNotFoundError("Failed to find the environmetn file")
+    loaded: bool = el.load_environment_file(path)
+    if not loaded:
+        raise RuntimeError("Failed to load my local environment")
+
+    report: RegionsReport = RegionsReport()
+
+    # Retrieve AWS regions with their status
+    regions_with_status = report.get_aws_regions_with_status()
+
+    # Export to CSV
+    report.export(regions_with_status)
+
+    # Export to JSON
+    report.export(regions_with_status, file_format="json")
+
+
+if __name__ == "__main__":
+    main()

{boto3_assist-0.1.2 → boto3_assist-0.1.4}/pyproject.toml

@@ -7,7 +7,7 @@ packages = ["src/boto3_assist"]
 
 [project]
 name = "boto3_assist"
-version = "0.1.2"
+version = "0.1.4"
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }
 ]

{boto3_assist-0.1.2 → boto3_assist-0.1.4}/requirements-dev.txt

@@ -2,6 +2,7 @@ boto3-stubs[dynamodb]
 build
 mypy
 mypy_boto3_dynamodb
+mypy_boto3_ec2
 moto [dynamodb2] # mocks for unit tests
 # setuptools
 types-python-dateutil

boto3_assist-0.1.4/src/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-0.1.2 → boto3_assist-0.1.4}/src/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-0.1.2 → boto3_assist-0.1.4}/src/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-0.1.4/src/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-0.1.2 → boto3_assist-0.1.4}/src/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-0.1.4/src/boto3_assist/version.py

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

boto3_assist-0.1.2/src/boto3_assist/version.py

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