Async / sync wrapper for Pyppeteer
pip install pdfmate
For simple async tasks:
import pdfmate
async def f():
await pdfmate.from_url('http://google.com', 'out.pdf')
await pdfmate.from_file('test.html', 'out.pdf')
await pdfmate.from_string('Hello!', 'out.pdf')Sync API is also provided at pdfmate.sync for all the above-mentioned functions:
import pdfmate
pdfmate.sync.from_url('http://google.com', 'out.pdf')
pdfmate.sync.from_file('test.html', 'out.pdf')
pdfmate.sync.from_string('Hello!', 'out.pdf')You can pass a list with multiple URLs or files:
pdfmate.sync.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.pdf')
pdfmate.sync.from_file(['file1.html', 'file2.html'], 'out.pdf')Also you can pass an opened file:
with open('file.html') as f:
pdfmate.sync.pdfmate(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 = pdfmate.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',
}
pdfmate.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="pdfmate-format" content="Legal"/>
<meta name="pdfmate-landscape" content="False"/>
</head>
Hello World!
</html>
"""
pdfmate.sync.from_string(body, 'out.pdf')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 forpdfmatespecific meta tags - by default this ispdfmate-.environ- the dict used to provide env variables to pyppeteer headless browser.
import pdfmate
pdfmate.configuration(options={'format': 'A4'})
async def f():
# The resultant PDF at 'output_file' will be in A4 size and 2.0 scale.
await pdfmate.from_string(html_string, output_file, options={'scale': 2.0})poetry install -v --no-root
poetry run pytest tests/
npx mrm lint-staged
npx husky install
This is adapted version of PDFGen-Python and python-PDFKit library, so big thanks to them!