Render HTML to PDF in Django site

python

pdf-generation

django-templates

html-rendering

byAlex Kataev·Nov 28, 2024

To **convert HTML to PDF in Django**, leverage **`weasyprint`**. Install it via `pip install weasyprint`. Here's an example of its standard use:

```python
from weasyprint import HTML
from django.http import HttpResponse

def convert_html_to_pdf(request):
    pdf = HTML(string='<h1>Your HTML here</h1>').write_pdf()
    response = HttpResponse(pdf, content_type='application/pdf')
    response['Content-Disposition'] = 'filename="your_file.pdf"'
    return response

This short but sweet piece of code will turn your HTML string into a PDF file, which will then be downloaded under the name "your_file.pdf".

Detailed steps with Django context

Rendering HTML from Django templates

An HTML string is not going to cut it when you need more complex output. Whip up your Django template like you are Gordon Ramsay in the kitchen and use the context to add the special sauce.

from django.template.loader import render_to_string

# In your view function
context = {'joke': 'Why do programmers prefer iOS development? Because on iOS, there are no Windows or Gates.'}
html_string = render_to_string('my_template.html', context)
pdf = HTML(string=html_string).write_pdf()

Making PDFs interactive

To embed dynamic visuals such as charts from Google Visualization API, or if you want to bring your Javascript scribbles alive, wkhtmltopdf is at your service. It's the Sherlock Holmes of PDF generation with amazing detective skills to unearth functionality from your code.

import pdfkit

pdfkit.from_string(rendered_html, 'my_pdf.pdf', configuration=config)

Remember to install wkhtmltopdf on your system since it's more of an off-stage hero doing the heavy lifting in the background.

Handling errors and in-memory PDF generation

Preparing for doom's day with error handling

PDF generation is like an over-excited puppy. It's all fun and games until something breaks. Don't forget to include error handling to fix any potential PDF generation mess.

try:
    # Your PDF generation logic here
    # because Murphy's law is watching
except Exception as e:
    # Log the error and gracefully remind the user that computers have bugs too

Using in-memory handling for better performance

In memory, no one can hear your storage scream! Use the io.BytesIO() to keep files in-memory and not give your storage a headache.

from io import BytesIO

buffer = BytesIO()
pdf = HTML(string=html_string).write_pdf(target=buffer)
response = HttpResponse(buffer.getvalue(), content_type='application/pdf')

Simplified solutions with `django-easy_pdf`

Implementing PDF generation with PDFTemplateView

For making the conversion as easy as pie, rely on django-easy_pdf which makes the process as simple as wrapping it up in a view:

from easy_pdf.views import PDFTemplateView

class HelloPDFView(PDFTemplateView):
    template_name = "pdf_hello.html"
    
    def get_context_data(self, **kwargs):
        return super(HelloPDFView, self).get_context_data(
            pagesize="A4",
            title="Hello, PDF!",
            **kwargs
        )

Dodging common pitfalls

Stay ahead of the game by avoiding deprecated methods and making sure you employ utf-8 encoding:

# Importing the right version and methods
from weasyprint import HTML

# Using utf-8 encoding for your HTML templates
HTML(string=your_utf8_encoded_html).write_pdf()