PDF views, the easy way
Switch branches/tags
Clone or download
Latest commit 327605b Apr 27, 2017

README.rst

Django PDF rendering

Django PDF rendering, the easy way.

Build Status Latest Version Wheel License

Developed at en.ig.ma software shop.

Development Version

Note: A new PDF rendering backend using WeasyPrint for more accurate rendering is in development under the develop branch. See https://github.com/nigma/django-easy-pdf/pull/34 for changes, testing and discussion.

If you rely on the xhtml2pdf rendering backend and templates pin the package version to django-easy-pdf>=0.1.1<0.2.0.

Overview

This app makes rendering PDF files in Django really easy. It can be used to create invoices, bills and other documents from simple HTML markup and CSS styles. You can even embed images and use custom fonts.

The library provides both Class-Based View that is almost a drop-in replacement for Django's TemplateView as well as helper functions to render PDFs in the backend outside the request scope (i.e. using Celery workers).

Quickstart

  1. Include django-easy-pdf, xhtml2pdf in your requirements.txt file. If you are on Python 3 you need to install the latest version of Reportlab and the beta version of xhtml2pdf:

    $ pip install xhtml2pdf>=0.2b1
    
  2. Add easy_pdf to INSTALLED_APPS.

  3. Create HTML template for PDF document and add a view that will render it:

    {% extends "easy_pdf/base.html" %}
    
    {% block content %}
        <div id="content">
            <h1>Hi there!</h1>
        </div>
    {% endblock %}
    
    from easy_pdf.views import PDFTemplateView
    
    class HelloPDFView(PDFTemplateView):
        template_name = 'hello.html'
  4. You can also use a mixin to output PDF from Django generic views:

    class PDFUserDetailView(PDFTemplateResponseMixin, DetailView):
        model = get_user_model()
        template_name = 'user_detail.html'

Documentation

The full documentation is at django-easy-pdf.readthedocs.io.

A live demo is at easy-pdf.herokuapp.com. You can run it locally after installing dependencies by running python demo.py script from the cloned repository or through Docker with make demo.

Dependencies

django-easy-pdf depends on:

  • django>=1.10
  • xhtml2pdf>=0.2b1
  • reportlab

License

django-easy-pdf is released under the MIT license.

Other Resources

Commercial Support

This app and many other help us build better software and focus on delivering quality projects faster. We would love to help you with your next project so get in touch by dropping an email at en@ig.ma.