Skip to main content

HTTP server that renders HTML to PDF

Project description

https://img.shields.io/pypi/v/html2pdf-server.svg https://img.shields.io/docker/automated/spoqa/html2pdf-server.svg

The name says it all. You request a POST with an HTML, and then you will get the response with the rendered PDF.

HTTP API

Send POST / request with Content-Type: text/html e.g.:

POST / HTTP/1.1
Content-Type: text/html; charset=utf-8
Accept: application/pdf

<!DOCTYPE>
<html>
<body>
  <h1>HTML to be rendered to PDF</h1>
  <p>This document will be rendered to PDF.</p>
</body>
</html>

(Note that you have to set Accept: application/pdf header.)

And then you will get a PDF document through its response e.g.:

HTTP/1.1 200 OK
Content-Type: application/pdf
Server: html2pdf-server

(...omitted...)

Available mime types

You can set Accept header to various mime types.

application/pdf

respond a PDF document. this type is the default type.

image/png

respond a PNG image.

image/jpeg

respond a JPEG image.

Session in curl

$ cat input.html
<!DOCTYPE>
<html>
<body>
  <h1>HTML to be rendered to PDF</h1>
  <p>This document will be rendered to PDF.</p>
</body>
</html>
$ curl --header 'Content-Type: text/html' \
       --data "`cat input.html`" \
       --output output.pdf \
       http://localhost:8080/
$ open output.pdf  # Use xdg-open on Linux

Result screenshot:

Result screenshot

Getting started using Docker

Due to its non-Python dependencies the easist way to use this is using Docker. The official Docker image exposes 8080 port for HTTP server.

$ docker run -p 8080:8080 spoqa/html2pdf-server

If you need a pong endpoint for health check specify PONG_PATH environment variable:

$ docker run -e PONG_PATH=/ping/ -p 8080:8080 spoqa/html2pdf-server
Serving on http://0.0.0.0:8080

Getting started without Docker

Installation

You can install it using pip:

$ pip install --user git+git://github.com/spoqa/html2pdf-server.git

Note that WeasyPrint has several dependencies that need to be installed using system package managers e.g. APT, Homebrew. Read the docs.

Running server

Use html2pdfd command:

$ html2pdfd --port 8080
Serving on http://0.0.0.0:8080

Or you can use your preferred WSGI server as well (WSGI endpoint is html2pdfd:app):

$ aiohttp-wsgi-serve html2pdfd:app
Serving on http://:::8080 http://0.0.0.0:8080

License

Distributed under AGPLv3 or later.

Changelog

Version 1.2.2

Released on January 31, 2017.

  • Fixed a crash during the server prints the first log.

Version 1.2.1

Released on January 31, 2017.

  • Docker image now includes built-in fonts for Chinese/Japanese/Korean.

Version 1.2.0

Released on January 27, 2017.

  • The prerequisite Python version became 3.5 or higher. Python 3.4 or lower are no more supported.

  • Replaced waitress with aiohttp-wsgi.

  • The Docker image now uses Python 3.5 instead of 3.4.

Version 1.1.0

Released on January 26, 2017.

  • Added an option to enable pong endpoint for health check.

    • PONG_PATH environment variable for Docker.

    • --pong-path option for CLI.

  • Fixed a bug that --help option crashed while it’s trying to render default values.

Version 1.0.0

Initial release. Released on January 25, 2017.

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

html2pdf-server-1.2.2.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

html2pdf_server-1.2.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file html2pdf-server-1.2.2.tar.gz.

File metadata

File hashes

Hashes for html2pdf-server-1.2.2.tar.gz
Algorithm Hash digest
SHA256 d72f2e42102b7603233bd5d2f8c48477915a0875ede257cd1bc187d421f5dc07
MD5 e7f3f18131900bb132e1b4c5fb5ce167
BLAKE2b-256 eb6753dcf60b7f1cabc4c6045df9fdac70fab7cabec12969ba61a6a72021c959

See more details on using hashes here.

File details

Details for the file html2pdf_server-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for html2pdf_server-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1b844692841f974ad6e3a51dff3455a97d4a82e62cd917eaf622d76f0dd019ad
MD5 3310ab69efd1071fa2bd3098e279151c
BLAKE2b-256 a0026fe669a4a9f407515d99e443f9670578159ccff9d6d522d4809bd13d4423

See more details on using hashes here.

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