Skip to main content

Simple python wrapper for wkhtmltopdf

Project description


A simple python wrapper for the wkhtmltopdf lib ( with flash support.



  • Xvfd

  • wkhtmltopdf

  • flashplugin-nonfree

  • python 2.5+



  1. Install Xvfd:

    $ sudo apt-get install xvfb
  2. Install Fonts:

    $ sudo apt-get install xfonts-100dpi xfonts-75dpi xfonts-scalable xfonts-cyrillic
  3. Install wkhtmltopdf:

    $ sudo apt-get install wkhtmltopdf
  4. Install flashplugin:

    $ sudo apt-get install flashplugin-nonfree


  1. From git:

    $ git clone
    $ cd python-wkhtmltopdf
    $ python install


Simple Usage::

  1. Use from class:

    from wkhtmltopdf import WKHtmlToPdf
    wkhtmltopdf = WKHtmlToPdf(
  2. Use from method:

    from wkhtmltopdf import wkhtmltopdf
    wkhtmltopdf(url='', output_file='~/example.pdf')
  3. Use from commandline (installed):

    $ python -m wkhtmltopdf.main ~/example.pdf
  4. Use the api (installed):

    $ python -m wkhtmltopdf.api &
    $ wget http://localhost:8888/?

Required Arguments:

  • url - the url to convert to pdf

  • output_file - the pdf file that you want to create

Optional Arguments:

  • screen_resolution (default: [1024, 768])

  • color_depth (default: 24 (bit))

  • flash_plugin (default: True)

  • disable_javascript (default: False)

  • delay (default: 0 (millisecs))

  • orientation (default: Portrait)

  • dpi (default: 100)

  • no_background (default: False)

  • grayscale (default: False)

  • http_username (default: None)

  • http_password (default: None)

  • header_html (default: None)

  • footer_html (default: None)


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wkhtmltopdf-0.2.tar.gz (9.7 kB view hashes)

Uploaded Source

Built Distributions

wkhtmltopdf-0.2-py2.7.egg (12.4 kB view hashes)

Uploaded Source

wkhtmltopdf-0.2-py2.6.egg (12.4 kB view hashes)

Uploaded Source

wkhtmltopdf-0.2-py2.5.egg (12.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page