下载wkhtmltopdf
https://wkhtmltopdf.org/downloads.html
安装完成后加入path路径,默认安装位置,可能需要重新启动pycharm
C:\Program Files\wkhtmltopdf\bin
github
https://github.com/JazzCore/python-pdfkit
安装python 包
pip install pdfkit
简单使用
Usage
For simple tasks:
import pdfkit pdfkit.from_url('http://google.com', 'out.pdf') pdfkit.from_file('test.html', 'out.pdf') pdfkit.from_string('Hello!', 'out.pdf')
import pdfkit
url = 'https://my.oschina.net/ahaoboy/blog'
pdfkit.from_url(url, 'p1.pdf')
You can pass a list with multiple URLs or files:
pdfkit.from_url(['google.com', 'yandex.ru', 'engadget.com'], 'out.pdf') pdfkit.from_file(['file1.html', 'file2.html'], 'out.pdf')
Also you can pass an opened file:
with open('file.html') as f: pdfkit.from_file(f, 'out.pdf')
If you wish to further process generated PDF, you can read it to a variable:
# Use False instead of output path to save pdf to a variable pdf = pdfkit.from_url('http://google.com', False)
You can specify all wkhtmltopdf options. You can drop '--' in option name. If option without value, use None, False or '' for dict value:. For repeatable options (incl. allow, cookie, custom-header, post, postfile, run-script, replace) you may use a list or a tuple. With option that need multiple values (e.g. --custom-header Authorization secret) we may use a 2-tuple (see example below).
options = { 'page-size': 'Letter', 'margin-top': '0.75in', 'margin-right': '0.75in', 'margin-bottom': '0.75in', 'margin-left': '0.75in', 'encoding': "UTF-8", 'custom-header' : [ ('Accept-Encoding', 'gzip') ] 'cookie': [ ('cookie-name1', 'cookie-value1'), ('cookie-name2', 'cookie-value2'), ], 'no-outline': None } pdfkit.from_url('http://google.com', 'out.pdf', options=options)
By default, PDFKit will show all wkhtmltopdf
output. If you don't want it, you need to pass quiet
option:
options = { 'quiet': '' } pdfkit.from_url('google.com', 'out.pdf', options=options)
Due to wkhtmltopdf command syntax, TOC and Cover options must be specified separately. If you need cover before TOC, use cover_first
option:
toc = { 'xsl-style-sheet': 'toc.xsl' } cover = 'cover.html' pdfkit.from_file('file.html', options=options, toc=toc, cover=cover) pdfkit.from_file('file.html', options=options, toc=toc, cover=cover, cover_first=True)
You can specify external CSS files when converting files or strings using css option.
Warning This is a workaround for this bug in wkhtmltopdf. You should try --user-style-sheet option first.
# Single CSS file css = 'example.css' pdfkit.from_file('file.html', options=options, css=css) # Multiple CSS files css = ['example.css', 'example2.css'] pdfkit.from_file('file.html', options=options, css=css)
You can also pass any options through meta tags in your HTML:
body = """ <html> <head> <meta name="pdfkit-page-size" content="Legal"/> <meta name="pdfkit-orientation" content="Landscape"/> </head> Hello World! </html> """ pdfkit.from_string(body, 'out.pdf') #with --page-size=Legal and --orientation=Landscape
Configuration
Each API call takes an optional configuration paramater. This should be an instance of pdfkit.configuration()
API call. It takes the configuration options as initial paramaters. The available options are:
wkhtmltopdf
- the location of thewkhtmltopdf
binary. By defaultpdfkit
will attempt to locate this usingwhich
(on UNIX type systems) orwhere
(on Windows).meta_tag_prefix
- the prefix forpdfkit
specific meta tags - by default this ispdfkit-
Example - for when wkhtmltopdf
is not on $PATH
:
config = pdfkit.configuration(wkhtmltopdf='/opt/bin/wkhtmltopdf') pdfkit.from_string(html_string, output_file, configuration=config)
Troubleshooting
-
IOError: 'No wkhtmltopdf executable found'
:Make sure that you have wkhtmltopdf in your $PATH or set via custom configuration (see preceding section). where wkhtmltopdf in Windows or which wkhtmltopdf on Linux should return actual path to binary.
-
IOError: 'Command Failed'
This error means that PDFKit was unable to process an input. You can try to directly run a command from error message and see what error caused failure (on some wkhtmltopdf versions this can be cause by segmentation faults)