Skip to main content

python-wkhtmltopdf

NOTE: This has been FORKED FROM https://github.com/qoda/python-wkhtmltopdf because the Python package (https://pypi.org/project/wkhtmltopdf/) is no longer maintained, but there are still those in the community who need to use this for production projects in Python 3.

A simple python wrapper for the wkhtmltopdf lib (https://github.com/wkhtmltopdf/wkhtmltopdf)

Requirements

System:

  • Linux 32/64 or OSX only (Windows is not supported at this stage)

  • Xvfd

  • wkhtmltopdf

  • python 3+

Installation

wkhtmltopdf (Linux)

  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

wkhtmltopdf (OSX)

  1. Install wkhtmltopdf:

    $ brew install wkhtmltopdf

python-wkhtmltopdf (Any Platform)

  1. Development:

    $ git clone git@github.com:jontsai/python3-wkhtmltopdf.git
    $ cd python3-wkhtmltopdf
    $ virtualenv .
    $ pip install -r requirements.pip
  2. PIP:

    $ pip install git+https://github.com/jontsai/python3-wkhtmltopdf.git
    
    or from pypi
    
    $ pip install python3-wkhtmltopdf

Usage

Simple Usage::

  1. Use from class:

    from wkhtmltopdf import WKHtmlToPdf
    
    wkhtmltopdf = WKHtmlToPdf(
        url='http://www.example.com',
        output_file='~/example.pdf',
    )
    wkhtmltopdf.render()
  2. Use from method:

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

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

    $ python -m wkhtmltopdf.api &
    $ wget http://localhost:8888/?url=example.com&output_file=example.pdf

Required Arguments:

  • url - the url to convert to pdf

  • output_file - the pdf file that you want to create

Optional Arguments:

  • enable-plugins (default: True)

  • disable-javascript (default: False)

  • no-background (default: False)

  • grayscale (default: False)

  • orientation (default: Portrait)

  • dpi (default: 100)

  • username (default: None)

  • password (default: None)

  • margin-bottom (default: 10)

  • margin-top (default: 10)

  • margin-left (default: 10)

  • margin-right (default: 10)

  • disable-smart-shrinking (default: False)

Authors:

Metadata

Release files for py3-wkhtmltopdf 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for py3-wkhtmltopdf 0.4.1
File Interpreter ABI Platform
py3_wkhtmltopdf-0.4.1-py3-none-any.whl Python 3 none any Details

Release files / py3_wkhtmltopdf-0.4.1-py3-none-any.whl

Download URL py3_wkhtmltopdf-0.4.1-py3-none-any.whl
Size 7.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d3a55dde7619d69043f006b7bb06a036f1bbcc7076d098f69536711020de9bcd
BLAKE2b-256 checksum
How to use checksums
a79cf91f9cfd7cf3c4b2bff5ab5314919ff5dbb9459f49b2310626c0cff700f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.54.0 CPython/3.8.5

Release history Release notifications | RSS feed

This release

0.4.1 This release

1 release file

0.4

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page