Add Text to Footer of PDF in Python SDK
API for working with Text in Footer of PDF documents using Cloud Python SDK.
Get StartedHow to add Text in Footer of PDF via Cloud Python SDK
To add Text in Footer 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 Text in Footer via Python
Aspose.PDF Cloud developers can easily load & add Text in Footer 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 text footer to the page on PDF document
Add Text in Footer of PDF using Python
import shutil
import json
import logging
from pathlib import Path
from asposepdfcloud import ApiClient, PdfApi, TextFooter, 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"
FOOTER_VALUE = "New Footer Value"
PAGE_NUMBER = 2
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_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):
""" 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_text_footer(self):
"""Append a new text footer to the PDF document."""
if self.pdf_api:
new_footer = TextFooter(
background = True,
horizontal_alignment = HorizontalAlignment.CENTER,
text_alignment = TextHorizontalAlignment.CENTER,
value = Config.FOOTER_VALUE
)
try:
response = self.pdf_api.post_document_text_footer(
Config.PDF_DOCUMENT_NAME, new_footer
)
if response.code == 200:
logging.info(f"append_text_footer(): Footer '{new_footer.value}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_text_footer(): Failed to add footer '{new_footer.value}' to the document '{Config.PDF_DOCUMENT_NAME}'. Response code: {response.code}")
except Exception as e:
logging.error(f"append_text_footer(): Error while adding footer: {e}")
def append_text_footer(self):
"""Append a new text footer to the PDF document."""
if self.pdf_api:
new_footer = TextFooter(
background = True,
horizontal_alignment = HorizontalAlignment.CENTER,
text_alignment = TextHorizontalAlignment.CENTER,
value = Config.FOOTER_VALUE
)
try:
response = self.pdf_api.post_document_text_footer(
Config.PDF_DOCUMENT_NAME, new_footer
)
if response.code == 200:
logging.info(f"append_text_footer(): Footer '{new_footer.value}' added to the document '{Config.PDF_DOCUMENT_NAME}'.")
else:
logging.error(f"append_text_footer(): Failed to add footer '{new_footer.value}' to the document '{Config.PDF_DOCUMENT_NAME}'. Response code: {response.code}")
except Exception as e:
logging.error(f"append_text_footer(): Error while adding footer: {e}")
def append_text_footer_page(self):
"""Append a new text footer to the page on PDF document."""
if self.pdf_api:
new_footer = TextFooter(
background = True,
horizontal_alignment = HorizontalAlignment.RIGHT,
text_alignment = TextHorizontalAlignment.CENTER,
value = Config.FOOTER_VALUE
)
try:
response = self.pdf_api.post_document_text_footer(
Config.PDF_DOCUMENT_NAME, new_footer, start_page_number=Config.PAGE_NUMBER, end_page_number=Config.PAGE_NUMBER
)
if response.code == 200:
logging.info(f"append_text_footer_page(): Footer '{new_footer.value}' added to the page #{Config.PAGE_NUMBER}.")
else:
logging.error(f"append_text_footer_page(): Failed to add footer '{new_footer.value}' to the document #{Config.PAGE_NUMBER}. Response code: {response.code}")
except Exception as e:
logging.error(f"append_text_footer_page(): Error while adding footer: {e}")
if __name__ == "__main__":
pdf_header_footer = pdfHederFooter()
pdf_header_footer.upload_document()
pdf_header_footer.append_text_footer()
pdf_header_footer.append_text_footer_page()
pdf_header_footer.download_result()
Work with Footer in PDF
Adding text to the footer of a PDF enhances document organization, professionalism, and usability. It is essential for branding, legal compliance, navigation, and security, making it a valuable feature for business, academic, and official documents. Add the Footer 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.