Django app for seamlessly displaying and downloading PDF documents in browser
Project description
Django PDF View
Purpose
The primary purpose of this Django package is to streamline the creation of PDF
documents and allow for easy viewing or downloading in the browser. The package
provides a solid foundation of HTML and CSS for PDF file layout. To use it,
simply create an HTML template for your PDF document, then create a view that
inherits from PDFView
and define the necessary class attributes to generate
the PDF.
This approach enables developers to focus on crafting the content and styles of their PDF pages without having to deal with complex layout issues.
Key Features
-
Predefined Page Layout: Includes built-in base HTML and CSS to help structure your PDF pages efficiently.
-
Flexible PDF Content and Styling: Easily create your own HTML template for the PDF document and customize the appearance by applying your own CSS.
-
PDF View Response Options: Seamlessly switch between viewing the PDF, displaying the HTML content, and downloading the PDF file.
Prerequisites
Installation
pip install django-pdf-view
or
poetry add django-pdf-view
Configuration
Add django-pdf-view
to your INSTALLED_APPS
in settings.py
:
INSTALLED_APPS = [
...
'django_pdf_view',
...
]
Usage
In order to create your own PDF, you need to implement your own view and template.
-
Create a new view to render the PDF:
# my_app/views.py from django_pdf_view.views.pdf_view import PDFView class MyPDFView(PDFView): template_name = 'my_app/my_pdf.html' title = 'My PDF Document' # optional filename = 'My PDF.pdf' # optional css_paths = [ # optional 'my_pdf/css/my_pdf.css', ]
-
Create a new template to define the content of your PDF page:
<!-- my_app/templates/my_app/pdf_page.html --> <div class="page"> <h1 class="my-title">{{ title }}</h1> <p class="my-text">{{ text }}</p> <p class="my-text">Additional PDF page text.</p> </div> <!-- Define more <div class="page"> elements for additional pages -->
-
Add the new URL patterns to your project's
urls.py
:# my_app/urls.py from django.urls import path from my_app.views import MyPDFView urlpatterns = [ path('pdf-file/', MyPDFView.as_view(response_type='pdf'), name='pdf-file'), path('pdf-html/', MyPDFView.as_view(response_type='html'), name='pdf-html'), path('pdf-download/', MyPDFView.as_view(response_type='download'), name='pdf-download'), ]
-
Visit the belows listed URLs:
- To view the PDF file: http://localhost:8000/pdf-file/
- To view the HTML: http://localhost:8000/pdf-html/
- To download the PDF file: http://localhost:8000/pdf-download/
Default template context
- PDF document:
title
: Title of the PDF document (used in<title>
tag).css
: Content of the CSS files specified in thecss_paths
attribute.content
: Content of the HTML template.response_type
: Type of the response (pdf
,html
ordownload
).
svg
template tag
svg
template tag is provided by the django-pdf-view
package. This template
tag can be used to include SVG images in the PDF document.
Usage example:
{% load svg %}
<!-- Some HTML content -->
{% svg 'path/to/image.svg' %}
<!-- Some more HTML content -->
Bugs/Requests
If you encounter any bugs or have any requests, please use GitHub issue tracker to report them.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Project details
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
File details
Details for the file django_pdf_view-2.2.0.tar.gz
.
File metadata
- Download URL: django_pdf_view-2.2.0.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.0-45-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b8d9442c02026ccc03321915d504289d85ce4842e06e0c999876aac4ba104b4 |
|
MD5 | 47517578d58eef41fcac6d034ee433f0 |
|
BLAKE2b-256 | 62912a1c7b9a63a836fdeff919b86e834c86af68ed6126af84ba7fd8df7f2868 |
File details
Details for the file django_pdf_view-2.2.0-py3-none-any.whl
.
File metadata
- Download URL: django_pdf_view-2.2.0-py3-none-any.whl
- Upload date:
- Size: 13.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.0-45-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97d70e98895f52dbc32f896a67026c9786074057fabf1cf95f3da357ca38b310 |
|
MD5 | d63859e0deea5aeeba356f97bff29975 |
|
BLAKE2b-256 | 3a9624a36cdf2a0d25af6abc198a60828356440160907954ec28aaa2307541e4 |