Skip to main content

Generate PDF from HTML with django

Project description

django-pdf-generator v0.1.3 on PyPi MIT license Stable


Convert HTML to pdf with django using phantomjs


  • Python (2.7) (Need to be tested for 3.x)
  • Django (1.10, 1.9) (Need to be tested for previous versions)
  • PhantomJS


Install using pip :

pip install django_pdf_generator

Add pdf_generator to your INSTALLED_APPS setting.


Put phantomjs binary on your path or set the path manually in your settings using PHANTOMJS_BIN_PATH settings (see below).


Generate a PDF with PDFGenerator class

Generate a pdf from an url

from pdf_generator.generators import PDFGenerator

pdf = PDFGenerator(url="",

Save it to the database using PdfDoc models :
        title="pdf_generator on github",
        description="Convert HTML to pdf with django using phantomjs")

Get the PDF as a Django ContentFile named ‘my_pdf_file.pdf’ :

pdf_content_file = pdf.get_content_file('my_pdf_file')

# Return a Django HttpResponse with the PDF Attached named 'my_pdf_file.pdf':
return pdf.get_http_response('my_pdf_file')

Return a Django HttpResponse with the PDF Attached named ‘my_pdf_file.pdf’:

return pdf.get_http_response('my_pdf_file')

Generate a pdf just like Django render function :

url(r'^invoice$', views.invoice, name='invoice'),

from pdf_generator.renderers import render_pdf

def invoice(request):
    Render an invoice
    The invoice.pdf file is returned
    return render_pdf('invoice', request, 'front/invoice.html')

Juste add ?html=1 to the url to view the HTML instead of getting the pdf file.

PDFGenerator options

The PDFGenerator class accepts the following arguments :

  • url [required]
  • paperformat [Required] default to ‘A4’, examples: “5in*7.5in”, “10cm*20cm”, “A4”, “Letter”
  • zoom [Optional] default to 1.
  • script [Optional] default to DEFAULT_RASTERIZE_SCRIPT, defines which render script to use.
  • temp_dir [Optional] default to DEFAULT_TEMP_DIR, defines which temp dir to use.

Model used for saving PDF

When using save(filename, title='', description='') method of PDFGenerator, the following model is used:

class PdfDoc(models.Model):
    Store each generated pdf
    title = models.CharField(verbose_name=_("Title"), max_length=255, blank=True)
    description = models.TextField(verbose_name=_("Description"), blank=True)
    document = models.FileField(verbose_name=_("Document PDF"), upload_to=pdf_settings.UPLOAD_TO)
    created_at = models.DateTimeField(auto_now=False, auto_now_add=True, verbose_name=_('Creation'))
    updated_at = models.DateTimeField(auto_now=True, auto_now_add=False, verbose_name=_('Update'))


Add your settings to your main django settings file. The settings are set by default to :

    'UPLOAD_TO': 'pdfs',
    'PHANTOMJS_BIN_PATH': 'phantomjs',
    'DEFAULT_RASTERIZE_SCRIPT': os.path.join(PDF_GENERATOR_DIR, 'rasterize.js'),
    'DEFAULT_TEMP_DIR': os.path.join(PDF_GENERATOR_DIR, 'temp'),
    'TEMPLATES_DIR': os.path.join(PDF_GENERATOR_DIR, 'templates/pdf_generator')


Define the directory or the function to be used when saving PDFs, default to pdfs.


Define the path to Phantomjs binary, default to phantomjs.


Define which render_script to use by default, default to rasterize.js inside the package.


Define the directory to use for temporarily generated pdf by PhantomJS. default to pdf_temp.


Define the directory to use for temporarily generated HTML files by PhantomJS. default to pdf_temp.


If you are having issues, please let us know or submit a pull request.


The project is licensed under the MIT License.

Project details

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_generator, version 0.1.3
Filename, size & hash File type Python version Upload date
django_pdf_generator-0.1.3-py2.py3-none-any.whl (12.9 kB) View hashes Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page