Add Image to Header of PDF in Python SDK
API for working with Image in Header of PDF documents using Cloud Python SDK.
Get StartedHow to add Image in Header of PDF via Cloud Python SDK
To add Image in Header of PDF, 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 Image in Header via Python
Aspose.PDF Cloud developers can easily load & add Image in Header of PDF in just a few lines of code.
- Install Python SDK
- Upload a PDF document to the Aspose Cloud server
- Download the processed PDF document from the Aspose Cloud server
- Append a new image header to the page on PDF document
Add Image in Header of PDF using Python
import shutil
import json
import logging
from pathlib import Path
from asposepdfcloud import ApiClient, PdfApi, ImageHeader, HorizontalAlignment, TextHorizontalAlignment
# 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"
IMAGE_HEADER_FILE = "sample.png"
PAGE_NUMBER = 2 # Your document page number...
class pdfHederFooter:
"""Class for managing PDF headers and footers 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_image_header(self):
"""Append a new image header to the PDF document."""
if self.pdf_api:
new_header = ImageHeader(
background = True,
horizontal_alignment = HorizontalAlignment.CENTER,
file_name = Config.IMAGE_HEADER_FILE,
width = 24,
height = 24
)
try:
response = self.pdf_api.post_document_image_header(
Config.PDF_DOCUMENT_NAME, new_header
)
if response.code == 200:
logging.info(f"append_image_header(): Header '{new_header.file_name}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_image_header(): Failed to add header '{new_header.file_name}' to the document '{Config.PDF_DOCUMENT_NAME}'. Response code: {response.code}")
except Exception as e:
logging.error(f"append_image_header(): Error while adding header: {e}")
def append_image_heade_page(self):
"""Append a new image header to the page on PDF document."""
if self.pdf_api:
new_header = ImageHeader(
background = True,
horizontal_alignment = HorizontalAlignment.LEFT,
file_name = Config.IMAGE_HEADER_FILE,
width = 24,
height = 24
)
try:
response = self.pdf_api.post_document_image_header(
Config.PDF_DOCUMENT_NAME, new_header, start_page_number=Config.PAGE_NUMBER, end_page_number=Config.PAGE_NUMBER
)
if response.code == 200:
logging.info(f"append_image_heade_page(): Header '{new_header.file_name}' added to the page #{Config.PAGE_NUMBER}.")
else:
logging.error(f"append_image_heade_page(): Failed to add header '{new_header.file_name}' to the page #{Config.PAGE_NUMBER}. Response code: {response.code}")
except Exception as e:
logging.error(f"append_image_heade_page(): Error while adding header: {e}")
if __name__ == "__main__":
pdf_header_footer = pdfHederFooter()
pdf_header_footer.upload_document()
pdf_header_footer.upload_file(Config.IMAGE_HEADER_FILE)
pdf_header_footer.append_image_header()
pdf_header_footer.append_image_heade_page()
pdf_header_footer.download_result()
Work with Header in PDF
Adding an image to the header of a PDF enhances branding, professionalism, readability, and security. It ensures consistency in business, legal, marketing, and technical documents, making them more visually appealing and functional. Add the Header into PDF documents with Aspose.PDF Cloud Python SDK.
With our Python library you can:
- Combine PDF documents.
- Split PDF Files.
- Convert PDF to other formats, and vice versa.
- Manipulate Annotations.
- Work with Images in PDF, etc.
- You can try out our free Apps to test the functionality online.