django-gotenberg 0.1.0

Render any Django template to a PDF using Gotenberg

Django Gotenberg is a Django app that provides a render_to_pdf function to render Django templates to PDF responses using a Gotenberg instance.

Static files referenced via {% static %} tags in the template are resolved and sent to Gotenberg alongside the rendered HTML so that images, stylesheets, and other assets are embedded correctly in the generated PDF.

Quick start

1. Run a Gotenberg instance:

   docker run --rm -p 3000:3000 gotenberg/gotenberg:8

2. Add GOTENBERG_HOST to your Django settings:

   GOTENBERG_HOST = 'http://localhost:3000'

3. Use render_to_pdf in your views:

   from django_gotenberg import render_to_pdf
   
   def my_view(request):
       return render_to_pdf(request, 'my_template.html', {'key': 'value'})
   
   # With a download filename:
   def my_download_view(request):
       return render_to_pdf(request, 'my_template.html', filename='report.pdf')

Configuration

All configuration is done via Django settings:

Setting	Description	Default
GOTENBERG_HOST	URL of the Gotenberg instance (required)	—
GOTENBERG_TIMEOUT	Request timeout in seconds	30.0
GOTENBERG_USERNAME	HTTP basic auth username	—
GOTENBERG_PASSWORD	HTTP basic auth password	—