https://github.com/vinyll/flask-pdf

Make any page downloadable as a PDF
https://github.com/vinyll/flask-pdf

flask html-convert pdf-generation print-friendly wkhtmltopdf

Last synced: 6 months ago
JSON representation

Make any page downloadable as a PDF

• Host: GitHub
• URL: https://github.com/vinyll/flask-pdf
• Owner: vinyll
• Created: 2017-02-27T20:38:33.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-28T03:24:27.000Z (about 9 years ago)
• Last Synced: 2025-08-12T18:44:49.902Z (7 months ago)
• Topics: flask, html-convert, pdf-generation, print-friendly, wkhtmltopdf
• Language: Python
• Size: 1000 Bytes
• Stars: 6
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Flask PDF - render any page in PDF

Great for a best printing result or an easy downloadable version

of a Flask web page.

## Requirements

- a Flask project with Python 3

- [wkhtmltopdf](http://wkhtmltopdf.org/) installed on the server

## Installation

    pip install -e git+https://github.com/vinyll/flask-pdf.git#egg=flaskpdf

In your flask file, add:

    from flask import Flask

    import flaskpdf

    app = Flask(__name__)

    flaskpdf.init_app(app)

Now browse any of your webpage adding '_.pdf_' extensions.

eg: http://example.org/page/1 is downloadable at http://example.org/page/1.pdf.

You could easily make a printer-friendly version of your current page:

    Print this page

## Configuration

You may want to tune the default configuration.

To do so, [read the Flask config documentation](http://flask.pocoo.org/docs/0.12/config/),

and play with these settings:

    # The URL to access a webpage download in PDF format

    PDF_URL_RULE = '/.pdf'

    # The path and options for wkhtmltopdf executation.

    # `{url}` will be replaced by the url of the page to transform

    # and `{output}` will be a temporary output file (auto-deleted).

    PDF_WKHTMLTOPDF_COMMAND = 'wkhtmltopdf --print-media-type {url} {output}'