boto3-assist 0.23.0__tar.gz → 0.25.0__tar.gz

{boto3_assist-0.23.0 → boto3_assist-0.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3_assist
-Version: 0.23.0
+Version: 0.25.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.23.0 → boto3_assist-0.25.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.23.0 → boto3_assist-0.25.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.23.0 → boto3_assist-0.25.0}/pyproject.toml

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

{boto3_assist-0.23.0 → boto3_assist-0.25.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.25.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.23.0 → boto3_assist-0.25.0}/src/boto3_assist/dynamodb/dynamodb.py

@@ -352,7 +352,7 @@ class DynamoDB(DynamoDBConnection):
             if not index_name:
                 index_name = key.name
             # turn it into a key expected by dynamodb
-            key = key.key()
+            key = key.key(query_key=True)
 
         kwargs: dict = {}
 

{boto3_assist-0.23.0 → boto3_assist-0.25.0}/src/boto3_assist/dynamodb/dynamodb_index.py

@@ -156,11 +156,22 @@ 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 (
+
+        if query_key:
+            key = self._build_query_key(
+                include_sort_key=include_sort_key,
+                condition=condition,
+                low_value=low_value,
+                high_value=high_value,
+            )
+            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
@@ -175,14 +186,15 @@ class DynamoDBIndex:
                 key[self.sort_key.attribute_name] = self.sort_key.value
 
             return key
-        else:
-            key = self._build_query_key(
-                include_sort_key=include_sort_key,
-                condition=condition,
-                low_value=low_value,
-                high_value=high_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.25.0/src/boto3_assist/version.py

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

boto3_assist-0.23.0/src/boto3_assist/version.py

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