Merge pull request #94 from aspose-pdf-cloud/develop

update to 25.3

Author: boiledgas

.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+{
+	"name": "Python 3",
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+	"postCreateCommand": "pip install -r requirements.txt",
+	"workspaceFolder": "/SDKs/Python",
+	"workspaceMount": "source=${localWorkspaceFolder},target=/SDKs/Python,type=bind,consistency=cached",
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"python.testing.unittestEnabled": true
+			}
+		}
+	},
+	"mounts": [
+		"source=${localWorkspaceFolder}/../../Settings,target=/Settings,type=bind,consistency=cached"
+	]
+}

README.md

@@ -30,8 +30,9 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 25.2
+## Enhancements in Version 25.3
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
+
 ## Requirements.
 Python 2.7 and 3.4+
 

Uses-Cases/Split/splitPages.py

@@ -0,0 +1,72 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, SplitResultResponse
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+
+class PdfSplitter:
+    """ Class for managing PDF pages using Aspose PDF Cloud API. """
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """ Initialize the API client. """
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("init_api(): Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"init_api(): Failed to load credentials: {e}")
+
+    def upload_document(self):
+        """ Upload a PDF document to the Aspose Cloud server. """
+        if self.pdf_api:
+            file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+            try:
+                self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+                logging.info(f"upload_document(): File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+            except Exception as e:
+                logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def download_result(self, pageName, pageIndex):
+        """ Download the processed PDF document page from the Aspose Cloud server. """
+        if self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(pageName)
+                local_path = Config.LOCAL_FOLDER / f"Page_{pageIndex}_{pageName}"
+                shutil.move(temp_file, str(local_path))
+                logging.info(f"download_result(): File successfully downloaded: {local_path}")
+            except Exception as e:
+                logging.error(f"download_result(): Failed to download file: {e}")
+
+    def split_document_by_pages(self):
+        """ Split source document by pages """
+        if self.pdf_api:
+            try:
+                response: SplitResultResponse = self.pdf_api.post_split_document(Config.PDF_DOCUMENT_NAME)
+
+                if response.code == 200:
+                    i = 0
+                    for a_doc in response.result.documents:
+                        self.download_result(a_doc.href, i)
+                        i = i + 1
+            except Exception as e:
+                logging.error(f"split_document_by_pages(): Failed in the PdfSplitter: {e}")
+
+if __name__ == "__main__":
+    pdf_splitter = PdfSplitter()
+    pdf_splitter.upload_document()
+    pdf_splitter.split_document_by_pages()

Uses-Cases/Split/splitRanges.py

@@ -0,0 +1,74 @@
+import shutil
+import json
+import logging
+from pathlib import Path
+from asposepdfcloud import ApiClient, PdfApi, SplitRangePdfOptions, PageRange, SplitResultResponse
+
+# Configure logging
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
+
+class Config:
+    """Configuration parameters."""
+    CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
+    LOCAL_FOLDER = Path(r"C:\Samples")
+    PDF_DOCUMENT_NAME = "sample.pdf"
+
+spltRanges: SplitRangePdfOptions = SplitRangePdfOptions([PageRange(1,3), PageRange(4,7)])
+
+class PdfSplitter:
+    """ Class for managing PDF pages using Aspose PDF Cloud API. """
+    def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
+        self.pdf_api = None
+        self._init_api(credentials_file)
+
+    def _init_api(self, credentials_file: Path):
+        """ Initialize the API client. """
+        try:
+            with credentials_file.open("r", encoding="utf-8") as file:
+                credentials = json.load(file)
+                api_key, app_id = credentials.get("key"), credentials.get("id")
+                if not api_key or not app_id:
+                    raise ValueError("init_api(): Error: Missing API keys in the credentials file.")
+                self.pdf_api = PdfApi(ApiClient(api_key, app_id))
+        except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
+            logging.error(f"init_api(): Failed to load credentials: {e}")
+
+    def upload_document(self):
+        """ Upload a PDF document to the Aspose Cloud server. """
+        if self.pdf_api:
+            file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
+            try:
+                self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
+                logging.info(f"upload_document(): File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
+            except Exception as e:
+                logging.error(f"upload_document(): Failed to upload file: {e}")
+
+    def download_result(self, pageName, pageIndex):
+        """ Download the processed PDF document page from the Aspose Cloud server. """
+        if self.pdf_api:
+            try:
+                temp_file = self.pdf_api.download_file(pageName)
+                local_path = Config.LOCAL_FOLDER / f"Page_{pageIndex}_{pageName}"
+                shutil.move(temp_file, str(local_path))
+                logging.info(f"download_result(): File successfully downloaded: {local_path}")
+            except Exception as e:
+                logging.error(f"download_result(): Failed to download file: {e}")
+
+    def split_document_by_ranges(self):
+        """ Split source document by ranges """
+        if self.pdf_api:
+            try:
+                response: SplitResultResponse = self.pdf_api.post_split_range_pdf_document(Config.PDF_DOCUMENT_NAME, spltRanges)
+
+                if response.code == 200:
+                    i = 0
+                    for a_doc in response.result.documents:
+                        self.download_result(a_doc.href, i)
+                        i = i + 1
+            except Exception as e:
+                logging.error(f"split_document_by_pages(): Failed in the PdfSplitter: {e}")
+
+if __name__ == "__main__":
+    pdf_splitter = PdfSplitter()
+    pdf_splitter.upload_document()
+    pdf_splitter.split_document_by_ranges()

asposepdfcloud/api_client.py

@@ -83,7 +83,7 @@ def __init__(self, app_key, app_sid, host=None, self_host=False):
         self.rest_client = RESTClientObject()
         self.default_headers = {}
         self.default_headers['x-aspose-client'] = 'python sdk'
-        self.default_headers['x-aspose-client-version'] = '25.2.0'
+        self.default_headers['x-aspose-client-version'] = '25.3.0'
 
         self.self_host = self_host
         self.app_key = app_key

asposepdfcloud/configuration.py

@@ -199,5 +199,5 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 3.0\n"\
-               "SDK Package Version: 25.2.0".\
+               "SDK Package Version: 25.3.0".\
                format(env=sys.platform, pyversion=sys.version)

setup.py

@@ -32,7 +32,7 @@
 from setuptools import setup, find_packages
 
 NAME = "asposepdfcloud"
-VERSION = "25.2.0"
+VERSION = "25.3.0"
 # To install the library, run the following
 #
 # python setup.py install

test/pdf_test.py

@@ -4262,7 +4262,7 @@ def testGetImageExtractAsPng(self):
         self.assertIsInstance(response, str)
 
     def testGetImageExtractAsSvg(self):
-        name = "Alfa.pdf"
+        name = "alfa.pdf"
         self.uploadFile(name)
 
         opts = {