Skip to main content
Version: Version 1.7

Get started with Python

This guide walks you through the steps to use the Pdftools SDK in a sample project with Python.

info

The Python interface is implemented as a wrapper around the Pdftools SDK's C API.

Prerequisites​

The Pdftools SDK for Python requires Python 3.6 or higher.

Getting started with a sample project​

Learn how to use the Pdftools SDK using a Python sample project and convert a PDF file to an image.

Download and run the sample​

  1. Download a sample project, and then unzip the file.

  2. Navigate to the root directory of the unzipped sample project, where pdf2_img_simple.py resides.

  3. Run the sample:

    python ./pdf2_img_simple.py <input_path> <output_path>

    For example, to render the sample PDF file PdfPrimerWhitePaper.pdf to a multi-page TIFF image format, run:

    python ./pdf2_img_simple.py PdfPrimerWhitePaper.pdf PdfPrimerWhitePaper.tiff
    note

    Run python3 instead on systems where only Python 3 is installed and python is not aliased.

Integrate the SDK into your application​

Integrate and initialize the Pdftools SDK into your application by following the instructions in the next sections.

Add the SDK to your project​

  1. Install the Python package:

    pip install https://pdftools-public-downloads-production.s3.eu-west-1.amazonaws.com/productkits/PDFSDK/latest/pdftools_sdk-latest.tar.gz

  2. From the Pdftools SDK code samples page, download any Python code sample.

  3. Unzip a code sample and review the README.md file with usage details. Every code sample includes a README.md with different usage instructions.

  4. Import the following packages in the header of your Python code:

    from ctypes import *
    from pdftools_sdk.py_ctypes import *
    from pdftools_sdk.streams import StreamDescriptor

Initialize the SDK​

To initialize the Pdftools SDK with your license key, follow these steps:

  1. Copy your license key. For more information, review Find the license key.

  2. Replace the <PDFSDK,V1,include-your-key-here> in the following function with the value of your license key:

    # Initialize library
    initialize()

    # Optional: Without a license key the Pdftools SDK returns watermarked results.
    # Initialize the Pdftools SDK with a license key to remove the watermark.
    # The Pdftools SDK returns an error if you use an invalid license key.
    if sdk_initialize("<PDFSDK,1,insert-license-key-here>", None) == 0:
      print_error_message("Failed to set the license key.")
      exit(1)

    Use the license key in the same format as you copied it. Include the less-than (<) and greater-than (>) signs.

Try it without license key

You can try the Pdftools SDK without a license with watermarked results. For more information, review Pdftools SDK license management. Without a valid license key the output files are watermarked. Get in touch with the Pdftools sales team through the Contact page to get a full license.

Uninitialize the SDK​

After processing files with the Pdftools SDK, call the Uninitialize method to unload the library correctly:

# Uninitialize library
uninitialize();
tip

Download other sample projects that show you how to implement specific use cases with the Pdftools SDK using Python. See our Code samples page. The samples include: