Append attachments in PDF documents via Cloud Python SDK
API for working with attachments in PDF documents with Aspose.PDF Cloud Python SDK
Get StartedHow to append attachments in PDF documents using Cloud Python SDK
For working with attachments in PDF documents, we’ll use Aspose.PDF Cloud Python SDK This Cloud SDK assists Python programmers in developing cloud-based PDF creator, annotator, editor, and converter apps using Python programming language via Aspose.PDF REST API. Simply create an account at Aspose for Cloud and get your application information. Once you have the App SID & key, you are ready to give the Aspose.PDF Cloud Python SDK. If the python package is hosted on Github, you can install directly from Github:
Installation from Github
pip install git+https://github.com/aspose-pdf-cloud/aspose-pdf-cloud-python.git
Package Manager Console Command
pip install asposepdfcloud
Steps to add attachments via Python SDK
Aspose.PDF Cloud Python developers can easily append attachments in PDF documents. Developers need just a few lines of code.
- Load your Application Secret and Key from the JSON file or set credentials in another way
- Create an object to connect to the Cloud API
- Set name with path of your document file
- Perform the appending attachment actions
- If successful, the modified PDF is downloaded and saved to a specified file
- If any errors occur during the process, they are caught and printed
This sample code shows append file attachment to PDF document using PDF Cloud Python SDK
import shutil
import json
import logging
from pathlib import Path
from asposepdfcloud import ApiClient, PdfApi, AttachmentInfo
# 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"
LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
NEW_ATTACHMENT_FILE = "sample_video.mp4"
NEW_ATTACHMENT_MIME = "video/mp4"
PAGE_NUMBER = 2
class PdfAttachments:
"""Class for managing PDF attachments 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_file(self, fileName: str):
""" Upload a local fileName to the Aspose Cloud server. """
if self.pdf_api:
file_path = Config.LOCAL_FOLDER / fileName
try:
self.pdf_api.upload_file(fileName, str(file_path))
logging.info(f"upload_file(): File '{fileName}' uploaded successfully.")
except Exception as e:
logging.error(f"upload_document(): Failed to upload file: {e}")
def upload_document(self):
""" Upload a PDF document to the Aspose Cloud server. """
self.upload_file(Config.PDF_DOCUMENT_NAME)
def download_result(self):
""" Download the processed PDF document from the Aspose Cloud server. """
if self.pdf_api:
try:
temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
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 append_attachmnet(self):
"""Append a new attachment to the PDF document."""
if self.pdf_api:
new_attachment = AttachmentInfo(
path = Config.NEW_ATTACHMENT_FILE,
description = 'This is a sample attachment',
mime_type = Config.NEW_ATTACHMENT_MIME,
name = Config.NEW_ATTACHMENT_FILE
)
try:
response = self.pdf_api.post_add_document_attachment(Config.PDF_DOCUMENT_NAME, new_attachment)
if response.code == 200:
logging.info(f"append_attachment(): attachment '{Config.NEW_ATTACHMENT_FILE}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_attachment(): Failed to add attachment to the document. Response code: {response.code}")
except Exception as e:
logging.error(f"append_attachment(): Error while adding attachment: {e}")
if __name__ == "__main__":
pdf_attachments = PdfAttachments()
pdf_attachments.upload_document()
pdf_attachments.upload_file(Config.NEW_ATTACHMENT_FILE)
pdf_attachments.append_attachmnet()
pdf_attachments.download_result()