Skip to content

maestrofjp/django-easy-pdf

 
 

Repository files navigation

django-easy-pdf

Django PDF rendering, the easy way.

Latest Version Downloads License

Developed at en.ig.ma software shop.

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>=0.0.6 and reportlab>=2.7,<3 in your requirements.txt file.

  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"

Documentation

The full documentation is at django-easy-pdf.rtfd.org.

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.

Dependencies

django-easy-pdf depends on:

  • django>=1.5.1
  • xhtml2pdf>=0.0.6
  • reportlab>=2.7,<3

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 [email protected].

About

PDF views, the easy way

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 78.8%
  • Shell 21.2%