vivifyhealthcare/pdf-generator-python

PDF-Generator-Python

PDF-Generator-Python using pdfkit

• pdfkit is a python library that can be used to generate PDF documents from HTML content easily and with automated flow control such as pagination and keeping text together. It uses wkhtmltopdf as a backend and can be used with Flask or Django to convert HTML to PDF in web applications.

Installation

1. Download library pdfkit:

    $ pip install pdfkit  (or pip3 for python3)
   

2. Install wkhtmltopdf:

   • Debian/Ubuntu:

       $ sudo apt-get install wkhtmltopdf
     

   • For Windows:

     (a) Download link: wkhtmltopdf

     (b)Set: PATH variable set binary folder in Environment variables.

     

Warning! Version in debian/ubuntu repos have reduced functionality (because it compiled without the wkhtmltopdf QT patches), such as adding outlines, headers, footers, TOC etc. To use this options you should install static binary from wkhtmltopdf site.

• Windows and other options: check wkhtmltopdf homepage for binary installers

use cases

---

(i) if you have html file already saved on your system:

 import pdfkit
 
 pdfkit.from_file('test.html', 'out.pdf')

(ii) if you have any website URl; which needs to be converted:

  import pdfkit
  
  pdfkit.from_url('http://google.com', 'out.pdf')

(iii) if you have series of string in the codes; which needs to be shown in the form of PDF:

  import pdfkit
 
  pdfkit.from_string('Hello!', 'out.pdf')

Configuration

---

Each API call takes an optional configuration parameter. This should be an instance of pdfkit.configuration() API call. It takes the configuration options as initial parameters. The available options are:

• wkhtmltopdf - the location of the wkhtmltopdf binary. By default pdfkit will attempt to locate this using which (on UNIX type systems) or where (on Windows).

• meta_tag_prefix - the prefix for pdfkit specific meta tags - by default this is pdfkit-

Windows Specific Configuration

Example - for when wkhtmltopdf is on $PATH:

   path_to_wkhtmltopdf = r"C:\Program Files\wkhtmltopdf\bin\wkhtmltopdf.exe" 

   config = pdfkit.configuration(wkhtmltopdf=path_to_wkhtmltopdf)

   pdfkit.from_file(html_string, output_file, configuration=config)

Linux/Ubuntu Specific Configuration

Example - for when wkhtmltopdf is not on $PATH:

Also you can use configuration() call to check if wkhtmltopdf is present in $PATH:

try:

  config = pdfkit.configuration()
  
pdfkit.from_string(html_string, output_file)

except OSError:

# not present in PATH

Get APIs Response and send to HTML:

API data segregation typically involves extracting relevant information from an API response and organizing it into a format that can be easily used and displayed     by an application. This may involve filtering, sorting, or manipulating the data in some way.Once the data has been segregated, it can be sent to HTML using           variety   of techniques   

Rendering Response Data to HTML

html

The html on django templates

Using Matplotlib

Matplotlib pie charts are used to display data in a circular graph, where the size of each slice represents the proportion of the whole. They are commonly used to visualize categorical data and the relative sizes of different categories. Examples of use cases include market share of different products, distribution of budget among different departments, or the breakdown of survey responses by answer choice.

sample example

We have five sections and each section have some scores, based on these scores we will draw a pie chart using matplotlib

• Connectedness

• Substance

• Nutrition

• Recovery

• Movement

output pdf

We will see the information on pdf for the sameple data:

• Profile Information

• Lifestyle scoring

• Vitals and Anthropometrics

• Immunization

• Appointments

from API's response we can save an create a PDF file. Here is the sample response pdf file created with pdf-generator-python

Common errors:

• IOError: 'No wkhtmltopdf executable found':

Make sure that you have wkhtmltopdf in your $PATH or set via custom configuration (see preceding section). where wkhtmltopdf in Windows or which wkhtmltopdf on Linux should return actual path to binary.

• IOError: 'Command Failed'

This error means that PDFKit was unable to process an input. You can try to directly run a command from error message and see what error caused failure (on some wkhtmltopdf versions this can be cause by segmentation faults)

PDF generation via API Endpoint

API Endpoint for to convert the HTML into PDF files and Storing those files into S3bucket and MongoDB database .

Pre-requisities: s3 bucket, IAM credentials & mongodb  

Follow the steps to using it as a REST API

make ensure you are inside the project / cloned repository

• pip install -r .requirements.txt
• python manage.py makemigrations.py
• python manage.py migrate
• python manage.py runserver

After successfully running the local host go to http://127.0.0.1:8000/pdf/gen/ this url.

upload your HTML file and then you got response be like this: {"url":<s3bucket url>}

• Initial Update

• Update-1

pdf-generator-python's Issues

I have another problem. After I converted my HTML file to a PDF file, the PDF file was garbled, and I specified UTF-8 encoding.

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

PDF Generator via API Endpoint

Convert The HTML To PDF By PDF Generator

Convert The HTML To PDF By PDF Generator in Projects developed on .net core or Node.

PDF Generator