HTML JPG PDF XML DOCX
  Product Family
PDF

Set PDF Forms in Python SDK

Set all of the form fields from a PDF Document using Python Cloud SDK

Get Started

Set an AcroForms from PDF document via Cloud Python SDK

In order to set an AcroForms from 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.

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 set AcroForms using Python

Aspose.PDF Cloud developers can easily load & set an acroforms from PDF in just a few lines of code.

  1. Read the local PDF file
  2. Create a field with new decorations
  3. Update the form field in the uploaded PDF
  4. Download the result if needed it
 

This sample code shows setting an AcroForms from PDF documents using Python


import os
import logging
from pathlib import Path
from asposepdfcloud import PdfApi, Field, FieldType

# Configure logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")

class PdfAcroforms:
    def __init__():
        """Initialize the API client."""
        credentials_file = Path(r"..\credentials.json")
        with credentials_file.open("r", encoding="utf-8") as file:
            credentials = json.load(file)
        api_key, app_id = credentials.get("key"), credentials.get("id")
        self.pdf_api = PdfApi(ApiClient(api_key, app_id))

    def replaceField(self, documentName: str, outputDocumentName: str, fieldName: str, localFolder: Path, remoteFolder: str):
        """ Upload a local fileName to the Aspose Cloud server. """
        file_path = localFolder / documentName
        self.pdf_api.upload_file(os.path.join(remoteFolder, fileName), file_path)

        field = Field(
            name="EMail",
            type=FieldType.TEXT,
            values=["aspose-pdf-cloud@example.com"]
        )
        try:
            response = self.pdf_api.put_update_field(documentName, fieldName, field, folder=remoteFolder)
            if response.code == 200:
                logging.info(f"PdfAcroforms(): Form filed '{fieldName}' successfully updated in the document.")
                """Download the processed PDF document from the Aspose Cloud server."""
                temp_file = self.pdf_api.download_file(str(remoteFolder) + '/' + documentName)
		local_path = localFolder / outputDocumentName
                shutil.move(temp_file, str(local_path))
            else:
                logging.error(f"PdfAcroforms(): Failed to add filed 'Email' to the page #1. Response code: {response.code}")
        except Exception as e:
            logging.error(f"PdfAcroforms(): Error while adding form field: {e}")
 

Work with the AcroForms via Python SDK

Setting AcroForms allows users to fill in information directly in the PDF, eliminating the need for separate tools or formats. Properly setting AcroForms ensures better usability, such as clear field labels, dropdown options, and logical tab orders for better navigation. Well-configured forms make it easy for multiple parties to fill out, review, and approve documents together. By setting AcroForms in PDFs, you can create reusable templates for recurring processes, saving time and ensuring consistency across documents. Set an AcroForms from PDF documents with Aspose.PDF Cloud Python SDK.

With our Python library you can

  • Add PDF document’s header & footer in text or image format.
  • Add tables & stamps (text or image) to PDF documents.
  • Append multiple PDF documents to an existing file.
  • Work with PDF attachments, annotations, & form fields.
  • Apply encryption or decryption to PDF documents & set a password.
  • Delete all stamps & tables from a page or entire PDF document.
  • Delete a specific stamp or table from the PDF document by its ID.
  • Replace single or multiple instances of text on a PDF page or from the entire document.
  • Extensive support for converting PDF documents to various other file formats.
  • Extract various elements of PDF files & make PDF documents optimized.
  • You can try out our free App to set the AcroForms from PDF files online and test the functionality.