my-aws-helpers 1.4.0__py2.py3-none-any.whl → 1.6.0__py2.py3-none-any.whl

my_aws_helpers/s3.py

@@ -1,13 +1,44 @@
 import boto3
 import io
 import json 
-from typing import Tuple
+from typing import Tuple, Optional
+from copy import copy
+import os 
+import gzip
+
+
+
+class S3Location:
+    bucket: str
+    file_name: str
+    location: str
+
+    @classmethod
+    def from_location(cls, location: str):
+        bucket, file_name = location.split('/')[0], '/'.join(location.split('/')[1:])
+        return cls(bucket = bucket, file_name = file_name)
+    
+    def __init__(self, bucket: str, file_name: str) -> None:
+        self.bucket = bucket
+        self.file_name = file_name
+        self.location = f"{self.bucket}/{self.file_name}"
+
+    def serialise(self):
+        return copy(vars(self))
+        
 
 class S3:
-    client: boto3.client
+    client: Optional[boto3.client]
+
+    def __init__(self, client: Optional[boto3.client]) -> None:
+        self.client = client if client else self._get_client()
 
-    def __init__(self) -> None:
-        self.client = boto3.client('s3')
+    def _get_client(self) -> boto3.client:
+        region_name = os.environ["AWS_DEFAULT_REGION"]
+        s3_client = boto3.client("s3", region_name=region_name)
+        endpoint_url = s3_client.meta.endpoint_url
+        s3_client = boto3.client("s3", region_name=region_name, endpoint_url=endpoint_url)
+        return s3_client
 
     def _streaming_body_to_dict(self, payload):
         file_like_obj = io.BytesIO(payload.read())
@@ -38,10 +69,48 @@ class S3:
             ExpiresIn = expires_in
         )
     
-    def get_s3_location_from_bucket_file(bucket_name: str, file_name: str) -> str:
-        return f"{bucket_name}/{file_name}"
+    def get_s3_location_from_bucket_file(bucket_name: str, file_name: str) -> S3Location:
+        return S3Location(bucket=bucket_name, file_name=file_name)
+    
+    def get_bucket_file_from_s3_location(s3_location: S3Location) -> S3Location:
+        return S3Location.from_location(location=s3_location)
+    
+    def save_document_content(
+        self, 
+        file_contents: bytes, 
+        file_name: str, 
+        bucket_name: str, 
+        content_encoding: str = "", 
+        content_type: str = "application/pdf",
+        compress: bool = True,
+    ) -> S3Location:
+        """
+        saves document content to bucket, in file_name
+        Options for content_type: 
+            "application/pdf"
+            "text/plain"
+            "application/json"
+            probably more
+        Options for content_encoding:
+            "": default encoding
+            "gzip": compressed contents
+        """
+        if compress or file_name.endswith(".gz"):
+            file_contents = gzip.compress(file_contents)
+            content_encoding = "gzip"
+        obj = self.client.Object(bucket_name, file_name)
+        obj.put(Body = file_contents, ContentType = content_type, ContentEncoding = content_encoding)
+        return S3Location(bucket=bucket_name, file_name=file_name)
     
-    def get_bucket_file_from_s3_location(s3_location: str) -> Tuple[str, str]:
-        bucket, file_name = s3_location.split('/')[0], "/".join(s3_location.split('/')[1:])
-        return bucket, file_name
-    
+    def read_binary_from_s3(self, s3_location: S3Location) -> bytes:
+        obj = self.client.Object(s3_location.bucket, s3_location.file_name)
+        d_bytes = io.BytesIO()
+        obj.download_fileobj(d_bytes)
+        d_bytes.seek(0)
+        if obj.content_encoding == "gzip":
+            try:
+                with gzip.GzipFile(fileobj=d_bytes) as gz_file:
+                    return gz_file.read()
+            except gzip.BadGzipFile:
+                d_bytes.seek(0)
+        return d_bytes.read()

{my_aws_helpers-1.4.0.dist-info → my_aws_helpers-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: my_aws_helpers
-Version: 1.4.0
+Version: 1.6.0
 Summary: AWS Helpers
 Home-page: https://github.com/JarrodMccarthy/aws_helpers.git
 Author: Jarrod McCarthy
@@ -10,5 +10,5 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Requires-Dist: boto3 ==1.34.36
+Requires-Dist: boto3==1.34.36
 

{my_aws_helpers-1.4.0.dist-info → my_aws_helpers-1.6.0.dist-info}/RECORD

@@ -2,10 +2,10 @@ my_aws_helpers/api.py,sha256=ph-MjSYl7mg_I1fN7S2DBRgQS90Spa8ARBiSZ6trliE,2330
 my_aws_helpers/cognito.py,sha256=gSaPncfzvnYJykf-Q9Mv8LGwJssynMBYL6LhOuF89_M,6447
 my_aws_helpers/dynamo.py,sha256=klDKoDujIuitp6c_yc1EWHkS67GJpXbck1ymhEgIMhE,4059
 my_aws_helpers/errors.py,sha256=_SCvVGOPYrkhOAxkO22u1cASGcBL8afHtg3xwX_FmY0,156
-my_aws_helpers/s3.py,sha256=k006EWFNcuIwaI351PZxBEHaodiTBJrrz8F4-pv8_28,1559
+my_aws_helpers/s3.py,sha256=79lBRxbs4-pkUlg3Pysx8YE9RHCdgfo1Y9-xxvNwrug,4062
 my_aws_helpers/sfn.py,sha256=YBuOMAhmCP2GzPMSDJ7bDe38eI7m9m5uiaeP6mwy3_Y,1848
-my_aws_helpers-1.4.0.dist-info/METADATA,sha256=iooMUki-dVS4EVewwHN8wJQ1ecW7_FXP6SxJsbH_FE0,453
-my_aws_helpers-1.4.0.dist-info/WHEEL,sha256=-G_t0oGuE7UD0DrSpVZnq1hHMBV9DD2XkS5v7XpmTnk,110
-my_aws_helpers-1.4.0.dist-info/top_level.txt,sha256=RK29MPT4_whrlRXrq_mXuB1Mo_xIyCI5BZc6QeP0olQ,15
-my_aws_helpers-1.4.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-my_aws_helpers-1.4.0.dist-info/RECORD,,
+my_aws_helpers-1.6.0.dist-info/METADATA,sha256=-cP27fz-MRMBtb2Yk07gb1tMCWv-uzDHQIj9dkozfQw,452
+my_aws_helpers-1.6.0.dist-info/WHEEL,sha256=0VNUDWQJzfRahYI3neAhz2UVbRCtztpN5dPHAGvmGXc,109
+my_aws_helpers-1.6.0.dist-info/top_level.txt,sha256=RK29MPT4_whrlRXrq_mXuB1Mo_xIyCI5BZc6QeP0olQ,15
+my_aws_helpers-1.6.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+my_aws_helpers-1.6.0.dist-info/RECORD,,

{my_aws_helpers-1.4.0.dist-info → my_aws_helpers-1.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py2-none-any
 Tag: py3-none-any