This page contains various examples of using the HTML to PDF API in Python. The examples are complete and fully functional. Read more about how to convert HTML to PDF in Python.
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'example.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertUrl('http://www.example.com') # 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: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # create an output stream for the conversion result output_stream = open('example.pdf', 'wb') # run the conversion and write the result into the output stream client.convertUrlToStream('http://www.example.com', output_stream) # close the output stream output_stream.close() except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and write the result to a file client.convertFileToFile('/path/to/MyLayout.html', 'MyLayout.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertFile('/path/to/MyLayout.html') # 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: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # create an output stream for the conversion result output_stream = open('MyLayout.pdf', 'wb') # run the conversion and write the result into the output stream client.convertFileToStream('/path/to/MyLayout.html', output_stream) # close the output stream output_stream.close() except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and write the result to a file client.convertStringToFile('<html><body><h1>Hello World!</h1></body></html>', 'HelloWorld.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertString('<html><body><h1>Hello World!</h1></body></html>') # 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: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # create an output stream for the conversion result output_stream = open('HelloWorld.pdf', 'wb') # run the conversion and write the result into the output stream client.convertStringToStream('<html><body><h1>Hello World!</h1></body></html>', output_stream) # close the output stream output_stream.close() except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setDebugLog(True) # run the conversion and write the result to a file client.convertFileToFile('/path/to/MyLayout.html', 'MyLayout.pdf') # print URL of the debug log print('Debug log url: {}'.format(client.getDebugLogUrl())) # print the number of conversion credits remaining in your account print('Remaining credit count: {}'.format(client.getRemainingCreditCount())) # print the number of credits used for the conversion print('Consumed credit count: {}'.format(client.getConsumedCreditCount())) # print the unique identifier for the conversion print('Job id: {}'.format(client.getJobId())) # print total number of pages in the output document print('Page count: {}'.format(client.getPageCount())) # print size of the output data in bytes print('Output size: {}'.format(client.getOutputSize())) except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setPageSize('Letter') client.setOrientation('landscape') client.setNoMargins(True) # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'letter_landscape.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setHeaderHeight('15mm') client.setFooterHeight('10mm') client.setHeaderHtml('<a class=\'pdfcrowd-source-url\' data-pdfcrowd-placement=\'href-and-content\'></a>') client.setFooterHtml('<center><span class=\'pdfcrowd-page-number\'></span></center>') client.setMarginTop('0') client.setMarginBottom('0') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'header_footer.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setEnablePdfForms(True) # run the conversion and write the result to a file client.convertStringToFile('<html><body>Enter name:<input type=text></body></html>', 'form.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setScaleFactor(300) # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'zoom_300.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setAuthor('Pdfcrowd') client.setTitle('Hello World') client.setSubject('Demo') client.setKeywords('Pdfcrowd,demo') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'with_metadata.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setPageLayout('single-page') client.setPageMode('full-screen') client.setInitialZoomType('fit-page') client.setOrientation('landscape') client.setNoMargins(True) # run the conversion and write the result to a file client.convertUrlToFile('https://pdfcrowd.com/api/', 'slide_show.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setElementToConvert('#main') # run the conversion and write the result to a file client.convertUrlToFile('https://pdfcrowd.com/api/', 'html_part.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setCustomJavascript('el=document.createElement(\'h2\'); el.textContent=\'Hello from Pdfcrowd API\'; el.style.color=\'red\'; el_before=document.getElementsByTagName(\'h1\')[0]; el_before.parentNode.insertBefore(el, el_before.nextSibling)') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'html_inject.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setViewportWidth(992) client.setRenderingMode('viewport') client.setSmartScalingMode('viewport-fit') client.setNoMargins(True) # run the conversion and write the result to a file client.convertUrlToFile('https://getbootstrap.com/', 'bootstrap.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys import io import zipfile try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # create ZIP archive in_stream = io.BytesIO() with zipfile.ZipFile(in_stream, 'w', zipfile.ZIP_DEFLATED) as zip_file: # add HTML content to the archive zip_file.writestr('index.html', '''<html> <head> <style> @font-face { font-family: 'OpenSans'; src: url(fonts/OpenSans.ttf) format('truetype'); } h1 { font-family: OpenSans; } </style> </head> <body> <h1>Hello World</h1> <img src='images/logo.png'> </body> </html>''') # add required local files to the archive with open("/your-path-to/fonts/OpenSans.ttf", "rb") as in_file: zip_file.writestr("fonts/OpenSans.ttf", in_file.read()) with open("/your-path-to/images/logo.png", "rb") as in_file: zip_file.writestr("images/logo.png", in_file.read()) in_stream.seek(0) # create an output stream for the conversion result output_stream = open('HelloFromZip.pdf', 'wb') # run the conversion and write the result into the output stream client.convertStreamToStream(in_stream, output_stream) # close the output stream output_stream.close() except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setCustomJavascript('libPdfcrowd.highlightHtmlElements({backgroundColor: \'rgba(255, 191, 0, 0.1)\', borderColor:null})') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'highlight_background.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setCustomJavascript('libPdfcrowd.highlightHtmlElements({borderColor: \'orange\', backgroundColor: null, padding: \'4px\', margin: \'4px\'})') # run the conversion and write the result to a file client.convertUrlToFile('http://www.example.com', 'highlight_borders.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setDataString("""{ "name": "World", "product": "Pdfcrowd API" }""") # run the conversion and write the result to a file client.convertStringToFile('Hello {{ name }} from {{ product }}', 'output.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setDataString("""<?xml version="1.0" encoding="UTF-8"?> <data> <name>World</name> <product>Pdfcrowd API</product> </data>""") # run the conversion and write the result to a file client.convertStringToFile('Hello {{ data.name }} from {{ data.product }}', 'output.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setDataString("""name: World product: Pdfcrowd API""") # run the conversion and write the result to a file client.convertStringToFile('Hello {{ name }} from {{ product }}', 'output.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import pdfcrowd import sys try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # configure the conversion client.setDataString("""name,product World,Pdfcrowd API""") # run the conversion and write the result to a file client.convertStringToFile('Hello {{ name }} from {{ product }}', 'output.pdf') except pdfcrowd.Error as why: sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) raise
import urllib.parse from django.http import HttpResponse from django.views.decorators.http import require_POST import pdfcrowd # the recommended method is POST @require_POST def convert(request): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # set HTTP response headers response = HttpResponse(content_type='application/pdf') response['Cache-Control'] = 'max-age=0' response['Accept-Ranges'] = 'none' response['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('example.pdf', safe='') # run the conversion and write the result into the output stream client.convertUrlToStream('http://www.example.com', response) return response except pdfcrowd.Error as why: # send the error in the HTTP response return HttpResponse(why.getMessage(), status=why.getCode(), content_type='text/plain')
import urllib.parse from django.http import HttpResponse from django.views.decorators.http import require_POST import pdfcrowd # the recommended method is POST @require_POST def convert(request): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # set HTTP response headers response = HttpResponse(content_type='application/pdf') response['Cache-Control'] = 'max-age=0' response['Accept-Ranges'] = 'none' response['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('MyLayout.pdf', safe='') # run the conversion and write the result into the output stream client.convertFileToStream('/path/to/MyLayout.html', response) return response except pdfcrowd.Error as why: # send the error in the HTTP response return HttpResponse(why.getMessage(), status=why.getCode(), content_type='text/plain')
import urllib.parse from django.http import HttpResponse from django.views.decorators.http import require_POST import pdfcrowd # the recommended method is POST @require_POST def convert(request): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # set HTTP response headers response = HttpResponse(content_type='application/pdf') response['Cache-Control'] = 'max-age=0' response['Accept-Ranges'] = 'none' response['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('HelloWorld.pdf', safe='') # run the conversion and write the result into the output stream client.convertStringToStream('<html><body><h1>Hello World!</h1></body></html>', response) return response except pdfcrowd.Error as why: # send the error in the HTTP response return HttpResponse(why.getMessage(), status=why.getCode(), content_type='text/plain')
import urllib.parse from flask import Flask, Response import pdfcrowd app = Flask(__name__) # the recommended method is POST @app.route('/', methods=['POST']) def convert(): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertUrl('http://www.example.com'); # send the result and set HTTP response headers response = Response(pdf, mimetype='application/pdf') response.headers['Cache-Control'] = 'max-age=0' response.headers['Accept-Ranges'] = 'none' response.headers['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('example.pdf', safe='') return response except pdfcrowd.Error as why: # send the error in the HTTP response return Response(why.getMessage(), status=why.getCode(), mimetype='text/plain')
import urllib.parse from flask import Flask, Response import pdfcrowd app = Flask(__name__) # the recommended method is POST @app.route('/', methods=['POST']) def convert(): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertFile('/path/to/MyLayout.html'); # send the result and set HTTP response headers response = Response(pdf, mimetype='application/pdf') response.headers['Cache-Control'] = 'max-age=0' response.headers['Accept-Ranges'] = 'none' response.headers['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('MyLayout.pdf', safe='') return response except pdfcrowd.Error as why: # send the error in the HTTP response return Response(why.getMessage(), status=why.getCode(), mimetype='text/plain')
import urllib.parse from flask import Flask, Response import pdfcrowd app = Flask(__name__) # the recommended method is POST @app.route('/', methods=['POST']) def convert(): try: # create the API client instance client = pdfcrowd.HtmlToPdfClient('demo', 'ce544b6ea52a5621fb9d55f8b542d14d') # run the conversion and store the result into the "pdf" variable pdf = client.convertString('<html><body><h1>Hello World!</h1></body></html>'); # send the result and set HTTP response headers response = Response(pdf, mimetype='application/pdf') response.headers['Cache-Control'] = 'max-age=0' response.headers['Accept-Ranges'] = 'none' response.headers['Content-Disposition'] = "attachment; filename*=UTF-8''" + urllib.parse.quote('HelloWorld.pdf', safe='') return response except pdfcrowd.Error as why: # send the error in the HTTP response return Response(why.getMessage(), status=why.getCode(), mimetype='text/plain')