boto3-assist 0.22.0__tar.gz → 0.24.0__tar.gz

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/.vscode/settings.json

@@ -28,6 +28,7 @@
     },
     "cSpell.words": [
         "addopts",
+        "dateutil",
         "geekcafe",
         "relativedelta"
     ],

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.22.0
+Version: 0.24.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.22.0 → boto3_assist-0.24.0}/README.md

@@ -6,7 +6,7 @@
 
 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
@@ -14,11 +14,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.
 
@@ -35,7 +35,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.22.0 → boto3_assist-0.24.0}/devops/build.py

@@ -62,7 +62,7 @@ def extract_version_and_write_to_file(pyproject_toml: str, version_file: str):
 
 def run_build():
     """Run python build commands"""
-    run_commands(["python", "-m", "build"])
+    run_commands(["python", "-m", "build", "--no-isolation"])
 
 
 def run_publish():

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/pyproject.toml

@@ -15,7 +15,7 @@ addopts = "-m 'not integration'"
 
 [project]
 name = "boto3_assist"
-version = "0.22.0"
+version = "0.24.0"
 
 authors = [
   { name="Eric Wilson", email="boto3-assist@geekcafe.com" }

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/requirements-dev.txt

@@ -20,4 +20,5 @@ pkginfo # occasionally we need to upgrade this or we can get upload errors when
 # 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. 
-pytest
+pytest
+hatchling

boto3_assist-0.24.0/setup.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# setup.sh - Cross-platform setup for python projects
+
+# Default mode: ask the user
+FETCH_LATEST="interactive"
+
+usage() {
+  cat <<EOF
+Usage: $0 [options]
+
+Options:
+  -u, --update       Automatically pull the latest setup.py (no prompt)
+  -n, --no-update    Skip pulling the latest setup.py
+  --ci               CI/CD mode (same as --update)
+  -h, --help         Show this help message and exit
+EOF
+  exit 0
+}
+
+# --- parse command-line flags ---
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    -u|--update)      FETCH_LATEST="yes" ;;
+    -n|--no-update)   FETCH_LATEST="no"  ;;
+    --ci)             FETCH_LATEST="yes" ;;
+    -h|--help)        usage ;;
+    *)  echo "Unknown option: $1" >&2
+        usage
+        ;;
+  esac
+  shift
+done
+
+# --- interactive prompt if needed ---
+if [[ "$FETCH_LATEST" == "interactive" ]]; then
+  read -r -p "Pull latest setup.py from repository? [y/N] " answer
+  if [[ "$answer" =~ ^[Yy] ]]; then
+    FETCH_LATEST="yes"
+  else
+    FETCH_LATEST="no"
+  fi
+fi
+
+# --- fetch if requested ---
+if [[ "$FETCH_LATEST" == "yes" ]]; then
+  echo "🔄 Fetching latest setup.py..."
+  curl -sSL \
+    https://raw.githubusercontent.com/geekcafe/py-setup-tool/main/setup.py \
+    -o setup.py
+fi
+
+# --- run the Python installer ---
+python3 setup.py

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -355,7 +355,9 @@ class DynamoDB(DynamoDBConnection):
             key = key.key()
 
         kwargs: dict = {}
-        if index_name:
+
+        if index_name and index_name != "primary":
+            # only include the index_name if we are not using our "primary" pk/sk
             kwargs["IndexName"] = f"{index_name}"
         kwargs["TableName"] = f"{table_name}"
         kwargs["KeyConditionExpression"] = key

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/src/boto3_assist/dynamodb/dynamodb_index.py

@@ -37,7 +37,7 @@ class DynamoDBIndexes:
         if index.name in self.__indexes:
             raise ValueError(
                 f"The index {index.name} is already defined in your model somewhere. "
-                "This error is generated to protect you from unforseen issues. "
+                "This error is generated to protect you from unforeseen issues. "
                 "If you models are inheriting from other models, you may have the primary defined twice."
             )
 
@@ -64,7 +64,7 @@ class DynamoDBIndexes:
         for _, v in self.__indexes.items():
             if v.partition_key.attribute_name == index.partition_key.attribute_name:
                 raise ValueError(
-                    f"The attrubute {index.partition_key.attribute_name} is already being used by index "
+                    f"The attribute {index.partition_key.attribute_name} is already being used by index "
                     f"{v.name}. "
                     f"Reusing this attribute would over write the value on index {v.name}"
                 )
@@ -73,7 +73,7 @@ class DynamoDBIndexes:
             for _, v in self.__indexes.items():
                 if v.sort_key.attribute_name == index.sort_key.attribute_name:
                     raise ValueError(
-                        f"The attrubute {index.sort_key.attribute_name} is already being used by index "
+                        f"The attribute {index.sort_key.attribute_name} is already being used by index "
                         f"{v.name}. "
                         f"Reusing this attribute would over write the value on index {v.name}"
                     )
@@ -156,21 +156,13 @@ 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 self.name == DynamoDBIndexes.PRIMARY_INDEX and include_sort_key:
-            # this is a direct primary key which is used in a get call
-            # this is differenet than query keys
-            key = {}
-            key[self.partition_key.attribute_name] = self.partition_key.value
 
-            if self.sort_key and self.sort_key.attribute_name:
-                key[self.sort_key.attribute_name] = self.sort_key.value
-
-            return key
-        else:
+        if query_key:
             key = self._build_query_key(
                 include_sort_key=include_sort_key,
                 condition=condition,
@@ -179,6 +171,31 @@ class DynamoDBIndex:
             )
             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
+            and not str(self.sort_key.value).endswith("#")
+        ):
+            # this is a direct primary key which is used in a get call
+            # this is different than query keys
+            key = {}
+            key[self.partition_key.attribute_name] = self.partition_key.value
+
+            if self.sort_key and self.sort_key.attribute_name:
+                key[self.sort_key.attribute_name] = self.sort_key.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-0.22.0 → boto3_assist-0.24.0}/src/boto3_assist/dynamodb/dynamodb_model_base.py

@@ -21,6 +21,7 @@ from boto3_assist.dynamodb.dynamodb_index import (
 from boto3_assist.dynamodb.dynamodb_reserved_words import DynamoDBReservedWords
 from boto3_assist.utilities.datetime_utility import DatetimeUtility
 from boto3_assist.models.serializable_model import SerializableModel
+from boto3_assist.utilities.string_utility import StringUtility
 
 
 def exclude_from_serialization(method):
@@ -190,7 +191,7 @@ class DynamoDBModelBase(SerializableModel):
     def to_dictionary(self, include_none: bool = True):
         """
         Convert the instance to a dictionary without an indexes/keys.
-        Usefull for turning an object into a dictionary for serialization.
+        Useful 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(
@@ -205,6 +206,13 @@ class DynamoDBModelBase(SerializableModel):
 
         return self.indexes.get(index_name)
 
+    @staticmethod
+    def generate_uuid(sortable: bool = True) -> str:
+        if sortable:
+            return StringUtility.generate_sortable_uuid()
+
+        return StringUtility.generate_uuid()
+
     @property
     @exclude_from_serialization
     def helpers(self) -> DynamoDBHelpers:

boto3_assist-0.24.0/src/boto3_assist/version.py

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

boto3_assist-0.24.0/tests/unit/dynamodb_tests/db_models/task.py

@@ -0,0 +1,76 @@
+from typing import Optional
+from boto3_assist.dynamodb.dynamodb_model_base import DynamoDBModelBase
+from boto3_assist.dynamodb.dynamodb_index import DynamoDBIndex
+from boto3_assist.dynamodb.dynamodb_key import DynamoDBKey
+from boto3_assist.utilities.string_utility import StringUtility
+
+
+class Task(DynamoDBModelBase):
+    """
+    A Generic Task Model
+
+    Using the same task.id, you can chain child elements via task.step_id
+
+    """
+
+    def __init__(self, id: Optional[str] = None):
+        super().__init__()
+        self.id: str = id or StringUtility.generate_uuid()
+        self._name: Optional[str] = None
+        self._step: Optional[str] = None
+        self._step_id: Optional[str] = None
+        self.metadata: dict = {}
+        self._setup_pk()
+
+    @property
+    def name(self) -> Optional[str]:
+        """
+        Returns the name for this task
+        """
+        return self._name
+
+    @name.setter
+    def name(self, value: str):
+        """
+        Sets the name for this task
+        """
+        self._name = value
+
+    @property
+    def step(self) -> Optional[str]:
+        """
+        Returns the step for this task
+        """
+        return self._step
+
+    @step.setter
+    def step(self, value: str):
+        """
+        Sets the step for this task
+        """
+        self._step = value
+
+    @property
+    def step_id(self) -> str | None:
+
+        return self._step_id
+
+    @step_id.setter
+    def step_id(self, value: str):
+        """
+        Sets the step_id for this task
+        """
+
+        self._step_id = value
+
+    def _setup_pk(self):
+        primary: DynamoDBIndex = DynamoDBIndex()
+        primary.name = "primary"
+        primary.partition_key.attribute_name = "pk"
+        primary.partition_key.value = lambda: DynamoDBKey.build_key(
+            (self.__class__.__name__, self.id)
+        )
+
+        primary.sort_key.attribute_name = "sk"
+        primary.sort_key.value = lambda: DynamoDBKey.build_key(("step", self.step_id))
+        self.indexes.add_primary(primary)

{boto3_assist-0.22.0 → boto3_assist-0.24.0}/tests/unit/dynamodb_tests/dynamodb_fail_if_exists_test.py

@@ -6,8 +6,8 @@ MIT License.  See Project Root for the license information.
 
 import unittest
 import moto
-
-from tests.unit.dynamodb_tests.db_models.user_model import User
+from typing import Optional
+from tests.unit.dynamodb_tests.db_models.task import Task
 from boto3_assist.environment_services.environment_loader import EnvironmentLoader
 from boto3_assist.dynamodb.dynamodb import DynamoDB
 from tests.unit.common.db_test_helpers import DbTestHelper
@@ -38,12 +38,10 @@ class DbQueryTest(unittest.TestCase):
 
     def test_fail_if_exists(self):
 
-        # create a few users
-
-        user_id: str = "123456789"
+        task_id: str = "123456789"
 
-        user = User(user_id)
-        response = self.db.save(table_name=self.__table_name, item=user)
+        task = Task(task_id)
+        response = self.db.save(table_name=self.__table_name, item=task)
 
         self.assertEqual(response["ResponseMetadata"]["HTTPStatusCode"], 200)
 
@@ -52,10 +50,10 @@ class DbQueryTest(unittest.TestCase):
             Exception,
             self.db.save,
             table_name=self.__table_name,
-            item=user,
+            item=task,
             fail_if_exists=True,
         )
 
         # this does not
-        response = self.db.save(table_name=self.__table_name, item=user)
+        response = self.db.save(table_name=self.__table_name, item=task)
         self.assertEqual(response["ResponseMetadata"]["HTTPStatusCode"], 200)

boto3_assist-0.24.0/tests/unit/dynamodb_tests/dynamodb_primary_key_sort_test.py

@@ -0,0 +1,82 @@
+"""
+Geek Cafe, LLC
+Maintainers: Eric Wilson
+MIT License.  See Project Root for the license information.
+"""
+
+import unittest
+import moto
+from typing import Optional
+from tests.unit.dynamodb_tests.db_models.task import Task
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.dynamodb.dynamodb import DynamoDB
+from tests.unit.common.db_test_helpers import DbTestHelper
+
+
+@moto.mock_aws
+class DbQueryTest(unittest.TestCase):
+    "Serialization Tests"
+
+    def __init__(self, methodName="runTest"):
+        super().__init__(methodName)
+
+        ev: EnvironmentLoader = EnvironmentLoader()
+        # NOTE: you need to make sure the the env file below exists or you will get an error
+        ev.load_environment_file(file_name=".env.unittest")
+        self.__table_name = "mock_test_table"
+
+        self.db: DynamoDB = DynamoDB()
+
+    def setUp(self):
+        # load our test environment file to make sure we override any default AWS Environment Vars setup
+        # we don't want to accidentally connect to live environments
+        # https://docs.getmoto.org/en/latest/docs/getting_started.html
+
+        self.db: DynamoDB = self.db or DynamoDB()
+        DbTestHelper().helper_create_mock_table(self.__table_name, self.db.client)
+        print("Setup Complete")
+
+    def create_data_process_task(
+        self,
+        name: str,
+        step: str,
+        task_id: Optional[str] = None,
+        metadata: Optional[dict] = None,
+    ) -> Task:
+        task = Task()
+        if task_id:
+            task.id = task_id
+            task.step_id = Task.generate_uuid()
+        else:
+            task.step_id = task.id
+        task.name = name
+        task.step = step
+
+        task.metadata = metadata
+        response = self.db.save(
+            table_name=self.__table_name, item=task, fail_if_exists=True
+        )
+        assert response["ResponseMetadata"]["HTTPStatusCode"] == 200
+        return task
+
+    def test_primary_key_query_sort(self):
+        task: Task = self.create_data_process_task(
+            name="test", step="test", task_id=None
+        )
+
+        # no create a bunch of children
+        for i in range(0, 10):
+            self.create_data_process_task(
+                name="test",
+                step=f"child-{i}",
+                task_id=task.id,
+                metadata={"child": f"i"},
+            )
+
+        query_model: Task = Task()
+        query_model.id = task.id
+        key = query_model.get_key("primary")
+        query_response = self.db.query(table_name=self.__table_name, key=key)
+
+        # primary task and 10 children == 11
+        assert len(query_response["Items"]) == 11

boto3_assist-0.22.0/src/boto3_assist/version.py

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