how-to response pdf   0   1312
Generating and Returning PDF as response in Django

We might need to generate a receipt or a report in PDF format in Django app. In this article, we will see how to generate a dynamic PDF from html content and return it as a response.

Create a Django project. If you are not using virtual environment, we strongly recommend to do so.

Installing Dependencies:

Once virtual environment is ready and activated, install the below dependencies.


For pdfkit  to work, we need wkhtmltopdf  installed in our Linux system.

sudo apt-get install wkhtmltopdf

View code:

To generate the PDF, we first need to create the HTML template which will be converted to PDF.

If its a static PDF, then it is recommended to create it once and upload on the server and provide the direct downloading link.

However if its a dynamic PDF like payment receipt or weekly report, we need to pass the data to template. For this we will use get_template method of template loader. For the sake of simplicity, we will pass user's name and date of birth to template. We convert the template to html string with variable values substituted in it and then generate the PDF from html string.

To return PDF as response, set the content_type as application/pdf in response.

from django.template.loader import get_template
import pdfkit
from django.http import HttpResponse

def index(request):
    data = dict()
    data["name"] = "ThePythonDjango.Com"
    data["DOB"] = "Jan 10, 2015"

    template = get_template('testapp/test.html')
    html = template.render(data)
    pdf = pdfkit.from_string(html, False)

    filename = "sample_pdf.pdf"

    response = HttpResponse(pdf, content_type='application/pdf')
    response['Content-Disposition'] = 'attachment; filename="' + filename + '"'
    return response


If you hit the URL, file will be downloaded.

generating and returning pdf as response in django  

pdfkit functions accept the configuration options in dictionary format.

pdf_settings = {
    'page-size': 'Letter',
    'margin-top': '0.75in',
    'margin-right': '0.75in',
    'margin-bottom': '0.75in',
    'margin-left': '0.75in',
    'encoding': "UTF-8",
    'no-outline': None

pdfkit.from_html(html_text, 'out.pdf', options=pdf_settings)

We can generate PDF from a URL directly, from html or from text using function pdfkit.from_url, pdfkit.from_html and pdfkit.from_text respectively.

Source Code:

A sample minimal project is available on Github.

Read more about pdfkit here.

how-to response pdf   0   1312

Related Articles:
Python Script 3: Validate, format and Beautify JSON string Using Python
Validating json using python code, format and beautify json file using python, validate json file using python, how to validate, format and beautify json...
Encryption-Decryption in Python Django
How to encrypt and decrypt the content in DJango. Encrypting the critical information in Django App. Encrypting username, email and password in Django...
Adding Robots.txt file to Django Application
Adding robots.txt file in your Django application. Easiest way to add robots.txt file. Django application robots.txt file. Why should you add robots.txt file in your Django Application....
Scraping 10000 tweets in 60 seconds using celery, RabbitMQ and Docker cluster with rotating proxy
Scrapping large amount of tweets within minutes using celery, RabbitMQ and docker cluster. Scraping huge data quickly using docker cluster with TOR....

0 thoughts on 'Generating And Returning Pdf As Response In Django'
Leave a comment:

*All Fields are mandatory. **Email Id will not be published publicly.

Please subscribe to get the latest articles in your mailbox.

Recent Posts:

© 2018-2019