Django WeasyPrint integration
Project description
Django-WeasyPrint
A Django WeasyPrint integration providing class-based view and response class for generating PDF from templates.
Installation
Install and update using pip:
pip install -U django-weasyprint
WeasyPrint is automatically installed as a dependency of this package. If you run into any problems be sure to check their install instructions for help!
Tip: In version 53 WeasyPrint switched to pydyf as PDF generator instead of Cairo. With that change PNG output was dropped and you might encounter other changes in the generated PDF.
You can continue using WeasyPrint/Cairo by installing django-weasyprint 1.x!
Usage
Use WeasyTemplateView as class based view base class or the
mixin WeasyTemplateResponseMixin on a TemplateView (or subclass
thereof).
Example
# views.py
import functools
from django.conf import settings
from django.views.generic import DetailView
from django_weasyprint import WeasyTemplateResponseMixin
from django_weasyprint.views import WeasyTemplateResponse
from django_weasyprint.utils import DjangoURLFetcher
class MyDetailView(DetailView):
# vanilla Django DetailView
template_name = 'mymodel.html'
class CustomURLFetcher(DjangoURLFetcher):
# rewrite requests for CDN URLs to file path in STATIC_ROOT to use local file
def fetch(self, url, headers=None):
cloud_storage_url = 'https://s3.amazonaws.com/django-weasyprint/static/'
if url.startswith(cloud_storage_url):
url = 'file://' + url.replace(cloud_storage_url, settings.STATIC_URL)
return super().fetch(url, headers)
class CustomWeasyTemplateResponse(WeasyTemplateResponse):
# use custom URLFetcher in response class
url_fetcher_class = CustomURLFetcher
# customized response class to pass a kwarg to already custom URLFetcher
def get_url_fetcher(self, *args, **kwargs):
# disable host and certificate check
context = ssl.create_default_context()
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
kwargs['ssl_context'] = context
return self.url_fetcher_class(*args, **kwargs)
class PrintView(WeasyTemplateResponseMixin, MyDetailView):
# output of MyDetailView rendered as PDF with hardcoded CSS
pdf_stylesheets = [
settings.STATIC_ROOT + 'css/app.css',
]
# show pdf in-line (default: True, show download dialog)
pdf_attachment = False
# custom response class with CustomURLFetcher and ssl_context
response_class = CustomWeasyTemplateResponse
class DownloadView(WeasyTemplateResponseMixin, MyDetailView):
# suggested filename (is required for attachment/download!)
pdf_filename = 'foo.pdf'
# set PDF variant to 'pdf/ua-1' (see weasyprint.DEFAULT_OPTIONS)
pdf_options = {'pdf_variant': 'pdf/ua-1'}
class DynamicNameView(WeasyTemplateResponseMixin, MyDetailView):
# dynamically generate filename
def get_pdf_filename(self):
return 'foo-{at}.pdf'.format(
at=timezone.now().strftime('%Y%m%d-%H%M'),
)
def simple_function_view(request):
# minimal boilerplate usage :)
return WeasyTemplateResponse(request, 'example.html', context={})
# tasks.py
from celery import shared_task
from django.template.loader import render_to_string
from django_weasyprint.utils import DjangoURLFetcher
@shared_task
def generate_pdf(filename='mymodel.pdf'):
weasy_html = weasyprint.HTML(
string=render_to_string('mymodel.html'),
url_fetcher=DjangoURLFetcher(),
base_url='file://',
)
weasy_html.write_pdf(filename)
<!-- mymodel.html -->
<!doctype html>
<html>
<head>
<!-- Use "static" template tag and configure STATIC_URL as usual. -->
<link rel="stylesheet" href="{% static 'css/app.css' %}" />
</head>
<body>
Hello PDF-world!
</body>
</html>
Settings
By default WeasyTemplateResponse determines the base_url for
weasyprint.HTML and weasyprint.CSS automatically using Django's
request.build_absolute_uri().
To disable that set WEASYPRINT_BASEURL to a fixed value, e.g.:
# Disable prefixing relative URLs with request.build_absolute_uri().
# Instead, handle them as absolute file paths.
WEASYPRINT_BASEURL = '/'
Changelog
See CHANGELOG.md
Links
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_weasyprint-2.5.0.tar.gz.
File metadata
- Download URL: django_weasyprint-2.5.0.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
362956b650d2a053967471c0ce15857f08e30253a3eeb746aef7c459d3ee9cf9
|
|
| MD5 |
f10f478a4de16599cd39055f94a4bf4a
|
|
| BLAKE2b-256 |
0e5ae4109aac85db984a020f4a3cff9836af13ee8bf5bdcf6e61818ea9422a48
|
File details
Details for the file django_weasyprint-2.5.0-py3-none-any.whl.
File metadata
- Download URL: django_weasyprint-2.5.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1607ef0c8223d7b15e7d4a501a3ec92fb6065179e667135aa50581b7d21aefa3
|
|
| MD5 |
340f8af11d5be3f9c7d6170612f092ea
|
|
| BLAKE2b-256 |
5cfd9e6646b91858f2d77fb625837dff0ad18b18649852e476e44ccefaca3ea1
|
