This page describes how to use our cloud-based API to convert web pages and HTML to PDF in Python. The API is user-friendly and can be integrated into your application with just a few lines of code. For general information about the converter, please visit our HTML to PDF API page.
The Python API client library provides easy access to the Pdfcrowd API. No third-party libraries are required.
Install the client library from PyPIpip install pdfcrowd
We also offer other installation options.
The credentials to access the API are your Pdfcrowd username and the API key. You can try out the API without registering using the following demo credentials:
demo
ce544b6ea52a5621fb9d55f8b542d14d
To get your personal API credentials, you can start a free API trial or buy the API license.
You can enter a web page or upload an HTML file to get a PDF output preview in our API playground. The playground allows you to interactively play with the API settings and autogenerates corresponding Python code that you can copy and paste to your application.
Or you can choose from the examples below and adapt the code to your needs.
Refer to the HTML to PDF Python Reference for a description of all API methods.
Here are a few Python examples to get you started quickly with the API. See more examples.
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: # report the error sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) # rethrow or handle the exception 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: # report the error sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) # rethrow or handle the exception 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: # report the error sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) # rethrow or handle the exception raise
The API can be easily integrated into your environment. You can have our interactive API Playground autogenerate the integration code for you:
You can also check out a complete example in our pdfcrowd-examples Github repository:
The API lets you convert a web page, a local HTML file, or a string containing HTML. The result of the conversion can be stored to a local file, to a stream object or to a variable. See the conversion input section for more details.
The best way to start with the API is to choose one of the examples and once you get it working, you can further customize the code. You can find the most common customizations in the table below.
Page size | Change the page size with setPageSize or setPageDimensions . Pass -1 to setPageHeight to get a single page PDF containing the whole document. |
Page orientation | Change the page orientation to landscape with setOrientation. |
Page margins | Adjust the page margins with setPageMargins. |
Headers and footers |
Add headers and footers with
setHeaderHtml and
setFooterHtml.
Set the height with setFooterHeight
and setHeaderHeight.
You can learn more in this tutorial. |
Zoom | Scale the HTML contents with setScaleFactor. |
Hide or remove elements |
You can use the following classes in your HTML
code to hide or remove elements from the output:
|
Use @media print | You can switch to the print version of the page (if it exists) with setUsePrintMedia. |
Force page break |
You can force a page break with<div style="page-break-before:always"></div>
|
Avoid page break |
You can avoid a page break inside an element with
the following CSSth, td, img { page-break-inside:avoid }
|
Run custom JavaScript | You can use setOnLoadJavascript or setCustomJavascript to alter the HTML contents with a custom JavaScript. In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library . |
Custom CSS styling |
You can alter CSS styling used during conversion
with a custom JavaScript or using the
pdfcrowd-body
CSS class, which is automatically set on the HTML
<body> element. You can, for example, set
the H1 height to 48px by adding the following line
to your CSS:
.pdfcrowd-body h1 { font-size: 48px; }
|
Add PDF signature | You can create PDF containing a digital signature field. Such PDF can be digitally signed in, for example, Adobe Acrobat or Preview. Learn more in Create Digital Signature in PDF . |
Fillable PDF form | You can create fillable PDF containing interactive fields and buttons. Learn more in Create Fillable PDF Form. |
The API enables rendering of HTML templates. The template syntax is based on the Jinja template rendering engine.
The most common constructs are:
Invoice: {{ invoice.number }}
{% for invoice in invoices %} ... {% endfor %}
{% if invoice.total > 100 %} ... {% endif %}
{{ invoice.to.first_name|capitalize }}
The supported input data formats are JSON, XML, CSV and YAML. The data can be uploaded from a file or from a string variable.
Supported template filters: capitalize, center, default, escape, first, forceescape, format, indent, join, last, length, list, lower, replace, reverse, safe, slice, sort, string, striptags, title, trim, truncate, unique, upper, wordcount, wordwrap.
See template rendering examples.
It is recommended that you implement error handling to catch errors that the API may return, see the example code below. A list of status codes and their description can be found here.
try: # call the API except pdfcrowd.Error as why: # print error sys.stderr.write('Pdfcrowd Error: {}\n'.format(why)) # print just error code sys.stderr.write('Pdfcrowd Error Code: {}\n'.format(why.getCode())) # print just error message sys.stderr.write('Pdfcrowd Error Message: {}\n'.format(why.getMessage())) # or handle the error in your way
libPdfcrowd.highlightHtmlElements
method call to visualize all HTML elements. See the
backgrounds example
,
borders example
and helper
JavaScript library
documentation.