Giter VIP home page Giter VIP logo

flask-pdf's Introduction

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 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:

<a href="{{ request.path }}.pdf">Print this page</a>

Configuration

You may want to tune the default configuration. To do so, read the Flask config documentation, and play with these settings:

# The URL to access a webpage download in PDF format
PDF_URL_RULE = '/<path:path>.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}'

flask-pdf's People

Contributors

vinyll avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.