boto3-assist 0.1.1__tar.gz → 0.1.3__tar.gz

{boto3_assist-0.1.1 → boto3_assist-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.1.1
+Version: 0.1.3
 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.3/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.3/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.1 → boto3_assist-0.1.3}/devops/readme.md

@@ -20,6 +20,4 @@ twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 
 pip install --index-url https://test.pypi.org/simple/ boto3-assist
 
-```
-
-pypi-AgEIcHlwaS5vcmcCJGQ0Zjk3ODRmLTgxZDMtNDViNy1iN2QwLWZkZDQzNTEyY2UwMgACKlszLCI3YzZmZTIzYS04MDVkLTQ0YjYtODlkZS04YTJiODJiNjBmMDQiXQAABiBxfnzdKtx6gff_FbuwKKV8D4b7XkUJJESxSqU1_mkCRA
+```

boto3_assist-0.1.1/examples/dynamodb/models/order_item.py → boto3_assist-0.1.3/examples/dynamodb/models/order_item_model.py

@@ -8,6 +8,7 @@ import datetime
 from typing import Optional
 from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
+from examples.dynamodb.models.product_model import Product
 
 
 class OrderItem(DynamoDBModelBase):
@@ -17,12 +18,12 @@ class OrderItem(DynamoDBModelBase):
         super().__init__()
         self.id: Optional[str] = None
         self.order_id: Optional[str] = None
-
-        self.product_id: Optional[str] = None
-        self.product_name: Optional[str] = None
+        self.product: Optional[Product] = None
+        # self.product_id: Optional[str] = None
+        # self.product_name: Optional[str] = None
         self.quantity: Optional[int] = 0
-        self.price: Optional[float] = 0.0
-        self.is_taxable: bool = False
+        # self.price: Optional[float] = 0.0
+        # self.is_taxable: bool = False
         self.is_discounted: bool = False
         self.created_utc: Optional[datetime.datetime] = None
         self.modified_utc: Optional[datetime.datetime] = None

boto3_assist-0.1.3/examples/dynamodb/models/order_model.py

@@ -0,0 +1,101 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import datetime
+from typing import Optional
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
+
+
+class Order(DynamoDBModelBase):
+    """Order Model"""
+
+    def __init__(
+        self,
+        id: Optional[str] = None,  # pylint: disable=w0622
+    ) -> None:
+        super().__init__()
+        self.id: Optional[str] = id
+        self.user_id: Optional[str] = None
+        self.created_utc: Optional[datetime.datetime] = None
+        self.modified_utc: Optional[datetime.datetime] = None
+        self.completed_utc: Optional[datetime.datetime] = None
+        self.status: Optional[str] = None
+        self.total: float = 0
+        self.tax_total: float = 0
+        self.__setup_indexes()
+
+    def get_completed_utc_ts(self) -> float | str:
+        """Get a time stamp representation of the completed date"""
+        if self.completed_utc is None:
+            return ""
+        return self.completed_utc.timestamp()
+
+    def get_completed_utc_yyyymmdd(self) -> str:
+        """Get a time stamp representation of the completed date"""
+        if self.completed_utc is None:
+            return "yyyymmdd"
+        value = f"{self.completed_utc.year}{str(self.completed_utc.month).zfill(2)}{str(self.completed_utc.day).zfill(2)}"
+        return value
+
+    def __setup_indexes(self):
+        # user id
+        primay: DynamoDBIndex = DynamoDBIndex()
+        primay.name = "primary"
+        primay.partition_key.attribute_name = "pk"
+        primay.partition_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        primay.sort_key.attribute_name = "sk"
+        primay.sort_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        self.indexes.add_primary(primay)
+
+        # all orders on a given day, sort by created date
+        self.indexes.add_secondary(
+            DynamoDBIndex(
+                index_name="gsi0",
+                partition_key=DynamoDBKey(
+                    attribute_name="gsi0_pk",
+                    value=lambda: DynamoDBKey.build_key(
+                        (
+                            "yyyymmdd",
+                            f"{self.get_completed_utc_yyyymmdd()}",
+                        )
+                    ),
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="gsi0_sk",
+                    value=lambda: DynamoDBKey.build_key(
+                        # when dealing with things like timestamps (or any numberfields)
+                        # you may want to exclude a prefix key
+                        # e.g. instead of: ("completed_utc_ts", self.get_completed_utc_ts())
+                        # do the following by passing an empty string
+                        ("", self.get_completed_utc_ts())
+                    ),
+                ),
+            )
+        )
+
+        # all user orders, sort by completed date
+        self.indexes.add_secondary(
+            DynamoDBIndex(
+                index_name="gsi1",
+                partition_key=DynamoDBKey(
+                    attribute_name="gsi1_pk",
+                    value=lambda: DynamoDBKey.build_key(
+                        ("user", self.user_id), ("orders", "")
+                    ),
+                ),
+                sort_key=DynamoDBKey(
+                    attribute_name="gsi1_sk",
+                    value=lambda: DynamoDBKey.build_key(
+                        # when dealing with things like timestamps (or any numberfields)
+                        # you may want to exclude a prefix key
+                        # e.g. instead of: ("completed_utc_ts", self.get_completed_utc_ts())
+                        # do the following by passing an empty string
+                        (None, self.get_completed_utc_ts())
+                    ),
+                ),
+            )
+        )

boto3_assist-0.1.1/examples/dynamodb/models/order_model.py → boto3_assist-0.1.3/examples/dynamodb/models/product_model.py

@@ -10,29 +10,35 @@ from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
 from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex, DynamoDBKey
 
 
-class Order(DynamoDBModelBase):
-    """Order Model"""
-
-    def __init__(self, id: Optional[str] = None) -> None:
+class Product(DynamoDBModelBase):
+    def __init__(
+        self,
+        id: Optional[str] = None,  # pylint: disable=w0622
+        name: Optional[str] = None,
+        price: float = 0.0,
+        description: Optional[str] = None,
+        sku: Optional[str] = None,
+    ):
         super().__init__()
+
         self.id: Optional[str] = id
-        self.user_id: Optional[str] = None
-        self.created_utc: Optional[datetime.datetime] = None
-        self.modified_utc: Optional[datetime.datetime] = None
-        self.completed_utc: Optional[datetime.datetime] = None
-        self.status: Optional[str] = None
-        self.total: float = 0
-        self.tax_total: float = 0
+        self.name: Optional[str] = name
+        self.price: float = price
+        self.description: Optional[str] = description
+        self.sku: Optional[str] = sku
+
         self.__setup_indexes()
 
+    def __str__(self):
+        return f"{self.name} - ${self.price}"
+
     def __setup_indexes(self):
-        # user id
         primay: DynamoDBIndex = DynamoDBIndex()
         primay.name = "primary"
         primay.partition_key.attribute_name = "pk"
-        primay.partition_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        primay.partition_key.value = lambda: DynamoDBKey.build_key(("product", self.id))
         primay.sort_key.attribute_name = "sk"
-        primay.sort_key.value = lambda: DynamoDBKey.build_key(("order", self.id))
+        primay.sort_key.value = lambda: DynamoDBKey.build_key(("product", self.id))
         self.indexes.add_primary(primay)
 
         self.indexes.add_secondary(
@@ -40,15 +46,12 @@ class Order(DynamoDBModelBase):
                 index_name="gsi0",
                 partition_key=DynamoDBKey(
                     attribute_name="gsi0_pk",
-                    value=lambda: DynamoDBKey.build_key(
-                        ("orders", ""), ("user", self.user_id)
-                    ),
+                    # hot key warning
+                    value=lambda: DynamoDBKey.build_key(("products", "")),
                 ),
                 sort_key=DynamoDBKey(
                     attribute_name="gsi0_sk",
-                    value=lambda: DynamoDBKey.build_key(
-                        ("completed_utc", self.created_utc)
-                    ),
+                    value=lambda: DynamoDBKey.build_key(("name", self.name)),
                 ),
             )
         )

boto3_assist-0.1.3/examples/dynamodb/order_example/main.py

@@ -0,0 +1,168 @@
+"""
+DynamoDB Example
+"""
+
+import json
+import os
+import random
+from pathlib import Path
+from typing import List
+from datetime import datetime, timedelta, UTC
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.utilities.serialization_utility import JsonEncoder
+from boto3_assist.utilities.string_utility import StringUtility
+from examples.dynamodb.services.table_service import DynamoDBTableService
+from examples.dynamodb.services.order_service import OrderService, Order
+from examples.dynamodb.services.order_item_service import OrderItemService, OrderItem
+from examples.dynamodb.models.product_model import Product
+
+
+class DynamoDBExample:
+    """An example of using and debuggin DynamoDB"""
+
+    def __init__(self, table_name: str) -> None:
+        self.db: DynamoDB = DynamoDB()
+        self.table_service: DynamoDBTableService = DynamoDBTableService(self.db)
+
+        self.table_name = table_name
+
+        self.order_service: OrderService = OrderService(self.db, table_name=table_name)
+        self.order_item_service: OrderItemService = OrderItemService(
+            self.db, table_name=table_name
+        )
+
+        self.__products: List[Product] = []
+        self.order_ids: list[str] = []
+
+        self.__load_products()
+
+    def __load_products(self):
+        """Load products"""
+        path = os.path.join(str(Path(__file__).parent.absolute()), "products.json")
+        if os.path.exists(path):
+            with open(path, "r", encoding="utf-8") as file:
+                prodcut_list = json.load(file)
+                self.__products = [Product(**product) for product in prodcut_list]
+        else:
+            raise FileNotFoundError("Failed to find the products file")
+
+    def run_examples(self):
+        """Run a basic examples with some CRUD examples"""
+
+        # I'm going to use a single table design pattern but you don't have to
+        self.table_service.create_a_table(table_name=self.table_name)
+        user_1 = StringUtility.generate_uuid()
+        five_days_ago = datetime.now(UTC) - timedelta(days=5)
+        four_days_ago = datetime.now(UTC) - timedelta(days=4)
+        user_2 = StringUtility.generate_uuid()
+        user_3 = StringUtility.generate_uuid()
+        user_4 = StringUtility.generate_uuid()
+        self.__generate_order(user_id=user_1, override_competed_date_utc=five_days_ago)
+        self.__generate_order(user_id=user_1, override_competed_date_utc=four_days_ago)
+        self.__generate_order(user_id=user_2)
+        self.__generate_order(user_id=user_3)
+        self.__generate_order(user_id=user_4)
+
+        self.__list_orders_from_known_id()
+
+        low = five_days_ago - timedelta(hours=1)
+        high = datetime.now(UTC)
+        print(f"checking for orders between {low} and {high} for {user_1}. Expecting 2")
+        self.__list_orders_for_user(
+            user_id=user_1, start_date_range=low, end_date_range=high
+        )
+
+        low = four_days_ago
+        high = low + timedelta(days=1)
+        print(
+            f"checking for orders between {low} and {high} for {user_1}. Expecting One"
+        )
+        self.__list_orders_for_user(
+            user_id=user_1, start_date_range=low, end_date_range=high
+        )
+
+    def __generate_order(
+        self,
+        user_id: str = None,
+        override_competed_date_utc: datetime | None = None,
+    ):
+        user_id = user_id or StringUtility.generate_uuid()
+        completed_date_utc = override_competed_date_utc or datetime.now(UTC)
+        order: Order = OrderService.new_order_object(user_id)
+        # technically we don't need to save this first
+        self.order_service.save(model=order)
+        # store the orders for later use
+
+        self.order_ids.append(order.id)
+        random_product_count = random.randint(1, 15)
+        for _ in range(random_product_count):
+            product: Product = self.__get_random_product()
+            order_item: OrderItem = OrderItem()
+            order_item.order_id = order.id
+            order_item.id = StringUtility.generate_uuid()
+            order_item.product = product
+            order_item.quantity = 1
+
+            self.order_item_service.save(model=order_item)
+            order.total += order_item.product.price * order_item.quantity
+
+        order.completed_utc = completed_date_utc
+        self.order_service.save(model=order)
+
+    def __get_random_product(self) -> Product:
+        """Return a random product from the list"""
+        if not self.__products:
+            raise ValueError("No products available")
+        return random.choice(self.__products)
+
+    def __list_orders_from_known_id(self):
+        """List the orders"""
+        print("######################################################")
+        print("Listing orders - looping through Order Ids")
+        for order_id in self.order_ids:
+            item: dict = self.order_service.get(
+                order_id=order_id, include_order_items=True
+            )
+            print(json.dumps(item, indent=2, cls=JsonEncoder))
+
+        print("End / Listing orders - looping through Order Ids")
+
+    def __list_orders_for_user(
+        self,
+        user_id: str,
+        start_date_range: datetime | None = None,
+        end_date_range: datetime | None = None,
+    ):
+        """List the orders for a user"""
+        print("######################################################")
+        print(f"Listing orders for user {user_id}")
+        items: list[dict] = self.order_service.list(
+            user_id=user_id, start_range=start_date_range, end_range=end_date_range
+        )
+        print(f"Found {len(items)} orders for user {user_id}")
+        # for item in items:
+        #     print(json.dumps(item, indent=2, cls=JsonEncoder))
+        print("End / Listing orders for user")
+
+
+def main():
+    """Main"""
+    # get an environment file name or default to .env.docker
+    env_file_name: str = os.getenv("ENVRIONMENT_FILE", ".env.docker")
+    path = os.path.join(str(Path(__file__).parents[3].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")
+
+    table_name = "application_table"
+    example: DynamoDBExample = DynamoDBExample(table_name=table_name)
+    # load a single table design
+    example.run_examples()
+
+
+if __name__ == "__main__":
+    main()