Pyppeteer-based async python wrapper to convert html to pdf
Project description
PDFGen-Python: HTML to PDF wrapper
Python 3.6.1+ async wrapper for Pyppeteer to convert HTML to PDF.
NOTE: All the public API functions are adapted to async coroutines, so use them with await!
This is adapted version of python-PDFKit library, so big thanks to them!
Installation
- Install pdfgen:
$ pip install pdfgen
- To download Chromium beforehand, run
$ pdfgen-setup. Otherwise, it'll be downloaded on the first run of library.
Usage
For simple async tasks:
import pdfgen
async def f():
await pdfgen.from_url('http://google.com', 'out.pdf')
await pdfgen.from_file('test.html', 'out.pdf')
await pdfgen.from_string('Hello!', 'out.pdf')
Sync API is also provided at pdfgen.sync for all the above-mentioned functions:
import pdfgen
pdfgen.sync.from_url('http://google.com', 'out.pdf')
pdfgen.sync.from_file('test.html', 'out.pdf')
pdfgen.sync.from_string('Hello!', 'out.pdf')
You can pass a list with multiple URLs or files:
pdfgen.sync.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.pdf')
pdfgen.sync.from_file(['file1.html', 'file2.html'], 'out.pdf')
Also you can pass an opened file:
with open('file.html') as f:
pdfgen.sync.pdfgen(f, 'out.pdf')
If you wish to further process generated PDF, you can read it to a variable:
# Ignore output_path parameter to save pdf to a variable
pdf = pdfgen.sync.from_url('http://google.com')
You can specify all Pyppeteer options used for saving PDF as shown below:
options = {
'scale': 2.0,
'format': 'Letter',
'margin': {
'top': '0.75in',
'right': '0.75in',
'bottom': '0.75in',
'left': '0.75in',
},
'pageRanges': '1-5,8',
}
pdfgen.sync.from_url('http://google.com', 'out.pdf', options=options)
You can also pass any options through meta tags in your HTML:
body = """
<html>
<head>
<meta name="pdfgen-format" content="Legal"/>
<meta name="pdfgen-landscape" content="False"/>
</head>
Hello World!
</html>
"""
pdfgen.sync.from_string(body, 'out.pdf')
Configuration
Each API call takes an optional options parameter to configure print PDF behavior. However, to reduce redundancy, one can certainly set default configuration to be used for all API calls. It takes the configuration options as initial paramaters. The available options are:
options- the dict used by default for pyppeteerpage.pdf(options)call.optionspassed as argument to API call will take precedence over the default options.meta_tag_prefix- the prefix forpdfgenspecific meta tags - by default this ispdfgen-.environ- the dict used to provide env variables to pyppeteer headless browser.
import pdfgen
pdfgen.configuration(options={'format': 'A4'})
async def f():
# The resultant PDF at 'output_file' will be in A4 size and 2.0 scale.
await pdfgen.from_string(html_string, output_file, options={'scale': 2.0})
Troubleshooting
InvalidSourceError: Provided HTML source is invalid (maybe wrong URL or non-existing file)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
