Generate PDF from HTML with django
Project description
django-pdf-generator
Convert HTML to pdf with django using phantomjs
Requirements
Python (2.7) (Need to be tested for 3.x)
Django (1.10, 1.9) (Need to be tested for previous versions)
PhantomJS
Installation
Install using pip :
pip install django_pdf_generator
Add pdf_generator to your INSTALLED_APPS setting.
INSTALLED_APPS = (
...
'pdf_generator',
)
Put phantomjs binary on your path or set the path manually in your settings using PHANTOMJS_BIN_PATH settings (see below).
Example
Generate a PDF with PDFGenerator class
Generate a pdf from an url
from pdf_generator.generators import PDFGenerator
pdf = PDFGenerator(url="https://github.com/charlesthk/django-pdf-generator",
Save it to the database using PdfDoc models :
pdf.save(
filename='pdf_generator',
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 :
urls.py
url(r'^invoice$', views.invoice, name='invoice'),
views.py
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'))
Settings
Add your settings to your main django settings file. The settings are set by default to :
PDF_GENERATOR = { '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') }
UPLOAD_TO
Define the directory or the function to be used when saving PDFs, default to pdfs.
PHANTOMJS_BIN_PATH
Define the path to Phantomjs binary, default to phantomjs.
DEFAULT_RASTERIZE_SCRIPT
Define which render_script to use by default, default to rasterize.js inside the package.
DEFAULT_TEMP_DIR
Define the directory to use for temporarily generated pdf by PhantomJS. default to pdf_temp.
TEMPLATES_DIR
Define the directory to use for temporarily generated HTML files by PhantomJS. default to pdf_temp.
Support
If you are having issues, please let us know or submit a pull request.
License
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.
Source Distributions
Built Distribution
Hashes for django_pdf_generator-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f812a25c453612ad8bcdfea483f6c43cdc215c1ee1bd4a71746488ec528ccc1 |
|
MD5 | c3ffeb40f1de46301015c0d0cc1dd505 |
|
BLAKE2b-256 | a4fad3c0e9f88fc3d29027e849f9ecc00d8ee55bc7e3ccfb262fdb3b5cd475d8 |