PDF to PDF Python Examples

This page contains various examples of using the PDF to PDF API in Python. The examples are complete and fully functional. Read more about how to convert PDF to PDF in Python.

Basic examples

Basic examples

Join 4 local PDF files together to a PDF file

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfFile('/path/to/cover.pdf')
    client.addPdfFile('/path/to/proposal.pdf')
    client.addPdfFile('/path/to/price.pdf')
    client.addPdfFile('/path/to/contact.pdf')

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Join 4 local PDF files together to in-memory PDF

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfFile('/path/to/cover.pdf')
    client.addPdfFile('/path/to/proposal.pdf')
    client.addPdfFile('/path/to/price.pdf')
    client.addPdfFile('/path/to/contact.pdf')

    # run the conversion and store the result into the "pdf" variable
    pdf = client.convert()

    # at this point the "pdf" variable contains PDF raw data and
    # can be sent in an HTTP response, saved to a file, etc.
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Join 4 local PDF files together and write the resulting PDF to an output stream

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfFile('/path/to/cover.pdf')
    client.addPdfFile('/path/to/proposal.pdf')
    client.addPdfFile('/path/to/price.pdf')
    client.addPdfFile('/path/to/contact.pdf')

    # create an output stream for the conversion result
    output_stream = open('offer.pdf', 'wb')

    # run the conversion and write the result into the output stream
    client.convertToStream(output_stream)

    # close the output stream
    output_stream.close()
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Join 4 in-memory PDFs together to a PDF file

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/contact.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Join 2 in-memory PDFs together with 2 local PDF files to a PDF file

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfFile('/path/to/proposal.pdf')
    client.addPdfRawData(open('/path/to/price.pdf', 'rb').read())
    client.addPdfFile('/path/to/contact.pdf')

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Add a watermark to a PDF file

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfFile('/path/to/proposal.pdf')
    client.setPageWatermark('/path/to/watermark.pdf')

    # run the conversion and write the result to a file
    client.convertToFile('company_offer.pdf')
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Linearize a PDF file

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.addPdfFile('/path/to/not_linearized.pdf')
    client.setLinearize(True)

    # run the conversion and write the result to a file
    client.convertToFile('linearized.pdf')
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Get info about the current conversion

import pdfcrowd
import sys

try:
    # create the API client instance
    client = pdfcrowd.PdfToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d')

    # configure the conversion
    client.setDebugLog(True)
    client.addPdfRawData(open('/path/to/cover.pdf', 'rb').read())
    client.addPdfRawData(open('/path/to/proposal.pdf', 'rb').read())

    # run the conversion and write the result to a file
    client.convertToFile('offer.pdf')
    
    # print URL to the debug log
    print('Debug log url: {}'.format(client.getDebugLogUrl()))
    
    # print the number of available conversion credits in your account
    print('Remaining credit count: {}'.format(client.getRemainingCreditCount()))
    
    # print the number of credits consumed by the conversion
    print('Consumed credit count: {}'.format(client.getConsumedCreditCount()))
    
    # print the unique ID of the conversion
    print('Job id: {}'.format(client.getJobId()))
    
    # print the total number of pages in the output document
    print('Page count: {}'.format(client.getPageCount()))
    
    # print the size of the output in bytes
    print('Output size: {}'.format(client.getOutputSize()))
except pdfcrowd.Error as why:
    # report the error
    sys.stderr.write('Pdfcrowd Error: {}\n'.format(why))

    # rethrow or handle the exception
    raise

Advanced examples

Template rendering Examples