Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Fill PDFs from model instances

Project description Coverage Status
Source code


Designed to make it easy for developers working with PDF’s to create views, pass model data, and have an easy to use GUI for field CRUD and layout.

  1. Supply a PDF document in the django-pdf-overlay admin screen.

  2. Create fields that match what you need filled out on the document.

  3. Using the layout tool, move the fields to their respective locations on the document.

  4. In your view, add similar to the following:

    # In this example I will load a user and pass it
    # to the PDF which has user.username as a field.
    from django.contrib.auth import get_user_model
    u = get_user_model().objects.get(pk=1)
    from django_pdf_overlay.models import Document
    doc = Document.objects.get(name='My Document')
    # Here we render the page(s) on the PDF
    # You can call render_pages multiple times to generate a single
    # PDF containing multiple copies of the base document.
    u2 = get_user_model().objects.get(pk=2)
    # If you wish to generate an actual file that you can store
    # in a model or somewhere on your system.
    file = doc.render_as_document(filename='users_1_2.pdf')
    # Or if you want the document to auto-download to the user
    return doc.render_as_response(filename='users_1_2.pdf')

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-pdf-overlay, version 1.0.6
Filename, size File type Python version Upload date Hashes
Filename, size django_pdf_overlay-1.0.6-py3-none-any.whl (165.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-pdf-overlay-1.0.6.tar.gz (160.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page