boto3-assist 0.2.2__tar.gz → 0.2.4__tar.gz

{boto3_assist-0.2.2 → boto3_assist-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3_assist
-Version: 0.2.2
+Version: 0.2.4
 Summary: Additional boto3 wrappers to make your life a little easier
 Author-email: Eric Wilson <boto3-assist@geekcafe.com>
 Classifier: License :: Other/Proprietary License

{boto3_assist-0.2.2 → boto3_assist-0.2.4}/pyproject.toml

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

{boto3_assist-0.2.2 → boto3_assist-0.2.4}/src/boto3_assist/s3/s3.py

@@ -7,6 +7,7 @@ MIT License.  See Project Root for the license information.
 import os
 import tempfile
 import time
+import io
 from typing import Any, Dict, List, Optional
 
 from aws_lambda_powertools import Logger
@@ -50,6 +51,19 @@ class S3(S3Connection):
             aws_secret_access_key=aws_secret_access_key,
         )
 
+    def create_bucket(self, bucket_name: str) -> None:
+        """
+        Create an S3 bucket
+        :param bucket_name: Bucket to create
+        :return: True if bucket is created, else False
+        """
+        try:
+            self.client.create_bucket(Bucket=bucket_name)
+            logger.info(f"Bucket {bucket_name} created")
+        except ClientError as e:
+            logger.exception(e)
+            raise e
+
     def generate_presigned_url(
         self,
         bucket_name: str,
@@ -139,7 +153,7 @@ class S3(S3Connection):
 
         return response
 
-    def upload_file_obj(self, bucket: str, key: str, file_obj: bytes) -> str:
+    def upload_file_obj(self, bucket: str, key: str, file_obj: bytes | str) -> str:
         """
         Uploads a file object to s3. Returns the full s3 path s3://<bucket>/<key>
         """
@@ -156,7 +170,13 @@ class S3(S3Connection):
             }
         )
         try:
-            self.client.upload_fileobj(Fileobj=file_obj, Bucket=bucket, Key=key)
+            # convert if necessary
+            file_obj: bytes = (
+                file_obj.encode("utf-8") if isinstance(file_obj, str) else file_obj
+            )
+            self.client.upload_fileobj(
+                Fileobj=io.BytesIO(file_obj), Bucket=bucket, Key=key
+            )
 
         except ClientError as ce:
             error = {
@@ -503,3 +523,19 @@ class S3(S3Connection):
         else:
             # Not in AWS Lambda, use the system's default temp directory
             return tempfile.gettempdir()
+
+    def encode(
+        self, text: str, encoding: str = "utf-8", errors: str = "strict"
+    ) -> bytes:
+        """
+        Encodes a string for s3
+        """
+        return text.encode(encoding=encoding, errors=errors)
+
+    def decode(
+        self, file_obj: bytes, encoding: str = "utf-8", errors: str = "strict"
+    ) -> str:
+        """
+        Decodes bytes to a string
+        """
+        return file_obj.decode(encoding=encoding, errors=errors)

{boto3_assist-0.2.2 → boto3_assist-0.2.4}/src/boto3_assist/utilities/file_operations.py

@@ -58,6 +58,16 @@ class FileOperations:
         dirname = os.path.dirname(path)
         return dirname
 
+    @staticmethod
+    def read_file(path: str, encoding: str = "utf-8") -> str:
+        """
+        Read a file
+        """
+        logger.debug(f"reading file {path}")
+        with open(path, "r", encoding=encoding) as file:
+            data = file.read()
+        return data
+
     @staticmethod
     def write_to_file(path: str, data: str, append: bool = False) -> str:
         """

boto3_assist-0.2.4/src/boto3_assist/version.py

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

boto3_assist-0.2.4/tests/s3/files/test.txt

@@ -0,0 +1 @@
+Test upload file

boto3_assist-0.2.4/tests/s3/s3_file_upload_test.py

@@ -0,0 +1,48 @@
+import os
+import unittest
+import moto
+from pathlib import Path
+from boto3_assist.s3.s3 import S3
+from boto3_assist.environment_services.environment_loader import EnvironmentLoader
+from boto3_assist.utilities.file_operations import FileOperations
+
+
+@moto.mock_aws
+class S3FileUploadTest(unittest.TestCase):
+    """Test S3 File Upload"""
+
+    def setUp(self):
+        """Setup"""
+        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")
+
+    def test_upload_file(self):
+        """Test uploading a file"""
+        s3 = S3()
+        bucket_name: str = "test-bucket"
+        s3.create_bucket(bucket_name)
+        local_file_path: Path = Path(
+            os.path.join(os.path.dirname(__file__), "files", "test.txt")
+        )
+        if not os.path.exists(local_file_path):
+            raise FileNotFoundError(f"File not found: {local_file_path}")
+
+        s3.upload_file(
+            bucket=bucket_name, key="test.txt", local_file_path=local_file_path
+        )
+
+    def test_upload_file_obj(self):
+        """Test uploading a file"""
+        s3 = S3()
+        bucket_name: str = "test-bucket"
+        s3.create_bucket(bucket_name)
+        local_file_path: Path = Path(
+            os.path.join(os.path.dirname(__file__), "files", "test.txt")
+        )
+        if not os.path.exists(local_file_path):
+            raise FileNotFoundError(f"File not found: {local_file_path}")
+
+        data = FileOperations.read_file(local_file_path)
+
+        s3.upload_file_obj(bucket=bucket_name, key="test.txt", file_obj=data)

boto3_assist-0.2.2/src/boto3_assist/version.py

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