pyaws-s3 1.0.1__tar.gz → 1.0.3__tar.gz

pyaws_s3-1.0.3/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Giuseppe Zileni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyaws_s3-1.0.3/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Giuseppe Zileni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{pyaws_s3-1.0.1 → pyaws_s3-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyaws_s3
-Version: 1.0.1
+Version: 1.0.3
 Summary: A Python package for AWS S3 utilities
 Author: Giuseppe Zileni
 Author-email: Giuseppe Zileni <giuseppe.zileni@gmail.com>
@@ -52,7 +52,7 @@ Dynamic: requires-python
 
 ## Description
 
-`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, and generating pre-signed URLs.
+`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, downloading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, generating pre-signed URLs, downloading files, listing files, and deleting individual files.
 
 ## Installation
 
@@ -62,16 +62,16 @@ Make sure you have installed:
 pip install pyaws_s3
 ```
 
-### Env Variabiles
+### Env Variables
 
-Make sure to add this environment variable:
+Make sure to add these environment variables:
 
 ```bash
 AWS_ACCESS_KEY_ID=<Your Access Key Id>
-AWS_SECRET_ACCESS_KEY=<Your Secrect Access Key>
+AWS_SECRET_ACCESS_KEY=<Your Secret Access Key>
 AWS_REGION=<Your Region>
 AWS_BUCKET_NAME=<Your Bucket Name>
-```bash
+```
 
 ## Usage
 
@@ -125,6 +125,52 @@ import asyncio
 await s3.delete_all(filter="your_filter")
 ```
 
+#### 5. `download(object_name, local_path=None, stream=False)`
+
+Downloads a file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to download.
+- `local_path` (str, optional): Local path to save the downloaded file. Required if `stream` is False.
+- `stream` (bool, optional): If True, returns the file content as bytes instead of saving locally.
+
+**Examples:**
+
+Download and save locally:
+
+```python
+local_path = s3.download("folder/image.svg", local_path="downloads/")
+```
+
+Download as bytes (stream):
+
+```python
+file_bytes = s3.download("folder/image.svg", stream=True)
+```
+
+#### 6. `list_files(filter=None) -> list[str]`
+
+Lists all files in the S3 bucket, optionally filtered by a substring.
+
+- `filter` (str, optional): Only files containing this substring will be listed.
+
+**Example:**
+
+```python
+files = s3.list_files(filter="folder/")
+```
+
+#### 7. `delete_file(object_name)`
+
+Deletes a single file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to delete.
+
+**Example:**
+
+```python
+s3.delete_file("folder/image.svg")
+```
+
 ## Notes
 
 - All upload methods return a pre-signed URL for downloading the file.
@@ -146,4 +192,13 @@ s3 = S3Client(bucket_name="my-bucket")
 img_url = s3.upload_image(fig, "test.svg")
 df_url = s3.upload_from_dataframe(df, "mydata")
 pdf_url = s3.upload_to_pdf("Hello PDF", "hello.pdf")
+
+# Download a file
+local_path = s3.download("test.svg", local_path="downloads/test.svg")
+
+# List files
+files = s3.list_files()
+
+# Delete a file
+s3.delete_file("test.svg")
 ```

{pyaws_s3-1.0.1 → pyaws_s3-1.0.3}/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, and generating pre-signed URLs.
+`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, downloading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, generating pre-signed URLs, downloading files, listing files, and deleting individual files.
 
 ## Installation
 
@@ -12,16 +12,16 @@ Make sure you have installed:
 pip install pyaws_s3
 ```
 
-### Env Variabiles
+### Env Variables
 
-Make sure to add this environment variable:
+Make sure to add these environment variables:
 
 ```bash
 AWS_ACCESS_KEY_ID=<Your Access Key Id>
-AWS_SECRET_ACCESS_KEY=<Your Secrect Access Key>
+AWS_SECRET_ACCESS_KEY=<Your Secret Access Key>
 AWS_REGION=<Your Region>
 AWS_BUCKET_NAME=<Your Bucket Name>
-```bash
+```
 
 ## Usage
 
@@ -75,6 +75,52 @@ import asyncio
 await s3.delete_all(filter="your_filter")
 ```
 
+#### 5. `download(object_name, local_path=None, stream=False)`
+
+Downloads a file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to download.
+- `local_path` (str, optional): Local path to save the downloaded file. Required if `stream` is False.
+- `stream` (bool, optional): If True, returns the file content as bytes instead of saving locally.
+
+**Examples:**
+
+Download and save locally:
+
+```python
+local_path = s3.download("folder/image.svg", local_path="downloads/")
+```
+
+Download as bytes (stream):
+
+```python
+file_bytes = s3.download("folder/image.svg", stream=True)
+```
+
+#### 6. `list_files(filter=None) -> list[str]`
+
+Lists all files in the S3 bucket, optionally filtered by a substring.
+
+- `filter` (str, optional): Only files containing this substring will be listed.
+
+**Example:**
+
+```python
+files = s3.list_files(filter="folder/")
+```
+
+#### 7. `delete_file(object_name)`
+
+Deletes a single file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to delete.
+
+**Example:**
+
+```python
+s3.delete_file("folder/image.svg")
+```
+
 ## Notes
 
 - All upload methods return a pre-signed URL for downloading the file.
@@ -96,4 +142,13 @@ s3 = S3Client(bucket_name="my-bucket")
 img_url = s3.upload_image(fig, "test.svg")
 df_url = s3.upload_from_dataframe(df, "mydata")
 pdf_url = s3.upload_to_pdf("Hello PDF", "hello.pdf")
+
+# Download a file
+local_path = s3.download("test.svg", local_path="downloads/test.svg")
+
+# List files
+files = s3.list_files()
+
+# Delete a file
+s3.delete_file("test.svg")
 ```

{pyaws_s3-1.0.1 → pyaws_s3-1.0.3}/pyaws_s3.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyaws_s3
-Version: 1.0.1
+Version: 1.0.3
 Summary: A Python package for AWS S3 utilities
 Author: Giuseppe Zileni
 Author-email: Giuseppe Zileni <giuseppe.zileni@gmail.com>
@@ -52,7 +52,7 @@ Dynamic: requires-python
 
 ## Description
 
-`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, and generating pre-signed URLs.
+`S3Client` is a Python class that simplifies interaction with AWS S3 for uploading, downloading, managing, and deleting files. It supports uploading images, DataFrames, PDFs, generating pre-signed URLs, downloading files, listing files, and deleting individual files.
 
 ## Installation
 
@@ -62,16 +62,16 @@ Make sure you have installed:
 pip install pyaws_s3
 ```
 
-### Env Variabiles
+### Env Variables
 
-Make sure to add this environment variable:
+Make sure to add these environment variables:
 
 ```bash
 AWS_ACCESS_KEY_ID=<Your Access Key Id>
-AWS_SECRET_ACCESS_KEY=<Your Secrect Access Key>
+AWS_SECRET_ACCESS_KEY=<Your Secret Access Key>
 AWS_REGION=<Your Region>
 AWS_BUCKET_NAME=<Your Bucket Name>
-```bash
+```
 
 ## Usage
 
@@ -125,6 +125,52 @@ import asyncio
 await s3.delete_all(filter="your_filter")
 ```
 
+#### 5. `download(object_name, local_path=None, stream=False)`
+
+Downloads a file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to download.
+- `local_path` (str, optional): Local path to save the downloaded file. Required if `stream` is False.
+- `stream` (bool, optional): If True, returns the file content as bytes instead of saving locally.
+
+**Examples:**
+
+Download and save locally:
+
+```python
+local_path = s3.download("folder/image.svg", local_path="downloads/")
+```
+
+Download as bytes (stream):
+
+```python
+file_bytes = s3.download("folder/image.svg", stream=True)
+```
+
+#### 6. `list_files(filter=None) -> list[str]`
+
+Lists all files in the S3 bucket, optionally filtered by a substring.
+
+- `filter` (str, optional): Only files containing this substring will be listed.
+
+**Example:**
+
+```python
+files = s3.list_files(filter="folder/")
+```
+
+#### 7. `delete_file(object_name)`
+
+Deletes a single file from the S3 bucket.
+
+- `object_name` (str): The name of the S3 object to delete.
+
+**Example:**
+
+```python
+s3.delete_file("folder/image.svg")
+```
+
 ## Notes
 
 - All upload methods return a pre-signed URL for downloading the file.
@@ -146,4 +192,13 @@ s3 = S3Client(bucket_name="my-bucket")
 img_url = s3.upload_image(fig, "test.svg")
 df_url = s3.upload_from_dataframe(df, "mydata")
 pdf_url = s3.upload_to_pdf("Hello PDF", "hello.pdf")
+
+# Download a file
+local_path = s3.download("test.svg", local_path="downloads/test.svg")
+
+# List files
+files = s3.list_files()
+
+# Delete a file
+s3.delete_file("test.svg")
 ```

{pyaws_s3-1.0.1 → pyaws_s3-1.0.3}/pyaws_s3.egg-info/SOURCES.txt

@@ -1,3 +1,5 @@
+LICENSE.md
+LICENSE.txt
 README.md
 pyproject.toml
 setup.py

{pyaws_s3-1.0.1 → pyaws_s3-1.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyaws_s3"
-version = "1.0.1"
+version = "1.0.3"
 description = "A Python package for AWS S3 utilities"
 authors = [
     { name="Giuseppe Zileni", email="giuseppe.zileni@gmail.com" }