You're Invited:Meet the Socket Team at RSAC and BSidesSF 2026, March 23–26.RSVP →
api2pdf
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
api2pdf - pypi Package Compare versions
+119
-116
| Metadata-Version: 2.1 | ||
| Name: api2pdf | ||
| Version: 0.0.8 | ||
| Version: 0.0.9 | ||
| Summary: Wrapper for api2pdf.com library for converting html, urls, and word documents to pdf | ||
@@ -9,24 +9,32 @@ Home-page: https://github.com/api2pdf/api2pdf.python | ||
| License: UNKNOWN | ||
| Description: # Api2Pdf - Python | ||
| [Api2Pdf.com](https://www.api2pdf.com) | [Docs](https://www.api2pdf.com/documentation) | ||
| Description: # api2pdf.python | ||
| Python bindings for [Api2Pdf REST API](https://www.api2pdf.com/documentation) | ||
| ## What is Api2Pdf? | ||
| Api2Pdf.com is a service for instantly generating PDFs. | ||
| Api2Pdf.com is a REST API for instantly generating PDF documents from HTML, URLs, Microsoft Office Documents (Word, Excel, PPT), and images. The API also supports merge / concatenation of two or more PDFs. Api2Pdf is a wrapper for popular libraries such as **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**. | ||
| - [Get Started](#get-started) | ||
| - [HTML](#convert-from-html) | ||
| - [URLs](#convert-from-urls) | ||
| - [Microsoft Office documents (Word, Excel, Powerpoint)](#convert-from-office) | ||
| - [Images](#convert-from-office) | ||
| - [Merge / Concatenate two or more PDFs](#merge) | ||
| - [Helper Methods](#helper-methods) | ||
| - [Installation](#installation) | ||
| - [Resources](#resources) | ||
| - [Authorization](#authorization) | ||
| - [Usage](#usage) | ||
| - [FAQ](#faq) | ||
| Api2Pdf provides access to **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**, along with the ability to merge / concatenate PDFs together. | ||
| ## <a name="installation"></a>Add a dependency | ||
| ### PyPI | ||
| ## <a name="get-started"></a>Get Started | ||
| This python library provides convenient methods for accessing the REST API [documented here](https://www.api2pdf.com/documentation/). | ||
| Run the pip command for installing the client `pip install api2pdf` | ||
| ## <a name="resources"></a>Resources | ||
| Resources this API supports: | ||
| - [wkhtmltopdf](#wkhtmltopdf) | ||
| - [Headless Chrome](#chrome) | ||
| - [LibreOffice](#libreoffice) | ||
| - [Merge / Concatenate PDFs](#merge) | ||
| - [Helper Methods](#helpers) | ||
| ## <a name="authorization"></a>Authorization | ||
| ### Acquire API Key | ||
@@ -36,17 +44,21 @@ 1. Create an account and login at [portal.api2pdf.com](https://portal.api2pdf.com) | ||
| 3. Create an application and grab your API Key | ||
| ### Install | ||
| pip install api2pdf | ||
| ### Usage | ||
| ## <a name="#usage"></a>Usage | ||
| ### Initialize the Client | ||
| All usage starts by calling the import command and initializing the client by passing your API key as a parameter to the constructor. | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| Once you initialize the client, you can make calls like so: | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response.result) | ||
| ### Sample Result | ||
| ### Result Object | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call. | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call, typically very small fractions of a penny. | ||
@@ -63,6 +75,5 @@ { | ||
| For debugging, you can simply print the `Api2PdfResponse` object to see the request and response data. | ||
| For debugging, you can print the `Api2PdfResponse` object to see the request and response data. | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response) | ||
@@ -73,6 +84,6 @@ | ||
| ---- API2PDF REQUEST ---- | ||
| - Headers: {'Authorization': 'f8bd6792-f1cd-42df-9bf9-f7a35e59362f'} | ||
| - Endpoint: https://v2018.api2pdf.com/merge | ||
| - Headers: {'Authorization': 'YOUR-API-KEY'} | ||
| - Endpoint: https://v2018.api2pdf.com/chrome/html | ||
| - Payload: | ||
| ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| {'html': '<p>Hello, World</p>'} | ||
| ---- API2PDF RESPONSE ---- | ||
@@ -82,75 +93,83 @@ {'pdf': 'https://link-to-pdf-only-available-for-24-hours', 'mbIn': 0.08421039581298828, 'mbOut': 0.08830547332763672, 'cost': 0.00017251586914062501, 'success': True, 'error': None, 'responseId': '163c4d25-25d7-4b82-bf50-907597d2ad46'} | ||
| ## Documentation | ||
| ### <a name="wkhtmltopdf"></a> wkhtmltopdf | ||
| ### <a name="convert-from-html"></a>Convert HTML to PDF | ||
| **Convert HTML to PDF** | ||
| We support both **wkhtmltopdf** and **Headless Chrome** with the endpoint to convert raw html to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| ##### HeadlessChrome.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| *Parameters:* | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', **options) | ||
| `html <string>` - raw string of html content | ||
| **Convert URL to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com') | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_html('<p>Hello World</p>') | ||
| print(headless_chrome_result.result) | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_html('<p>Hello World</p>') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| ### <a name="convert-from-url"></a>Convert URL to PDF | ||
| **Convert URL to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| We support both wkhtmltopdf and Headless Chrome with the endpoint to convert urls to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', **options) | ||
| ##### HeadlessChrome.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| --- | ||
| *Parameters:* | ||
| ## <a name="chrome"></a>Headless Chrome | ||
| `url <string>` - url to a pdf that Api2Pdf can consume | ||
| **Convert HTML to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', **options) | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| **Convert URL to PDF** | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(headless_chrome_result.result) | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| **Convert URL to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', **options) | ||
| ### <a name="convert-from-office"></a>Convert Microsoft Office Documents and Images to PDF | ||
| --- | ||
| We use **LibreOffice** to convert the following formats to PDF: | ||
| ## <a name="libreoffice"></a>LibreOffice | ||
| LibreOffice supports the conversion to PDF from the following file formats: | ||
| - doc, docx, xls, xlsx, ppt, pptx, gif, jpg, png, bmp, rtf, txt, html | ||
@@ -160,61 +179,45 @@ | ||
| ##### LibreOffice.convert_from_url(url, inline_pdf=False, file_name=None) | ||
| **Convert Microsoft Office Document or Image to PDF** | ||
| *Parameters:* | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx') | ||
| **Convert Microsoft Office Document or Image to PDF (load PDF in browser window and specify a file name)** | ||
| `url <string>` - url to a file of one of the supported formats above | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx', inline_pdf=True, file_name='test.pdf') | ||
| libreoffice_result = a2p.LibreOffice.convert_from_html('https://LINK-TO-YOUR-FILE') | ||
| print(libreoffice_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| ## <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| To use the merge endpoint, supply a list of urls to existing PDFs. The engine will consume all of the PDFs and merge them into a single PDF, in the order in which they were provided in the list. | ||
| ##### merge(list_of_urls, inline_pdf=False, file_name=None) | ||
| **Merge PDFs from list of URLs to existing PDFs** | ||
| *Paramaters:* | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| `list_of_urls <list>` - list of urls to pdfs | ||
| **Merge PDFs from list of URLs to existing PDFs (load PDF in browser window and specify a file name)** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs, inline_pdf=True, file_name='test.pdf') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| print(merge_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="helper-methods"></a>Helper Methods | ||
| ## <a name="helpers"></a>Helper Methods | ||
| ##### Api2PdfResponse: download_pdf() | ||
| **Api2PdfResponse: download_pdf()** | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy download_pdf() method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy `download_pdf()` method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| pdf_as_file_object = merge_result.download_pdf() | ||
| ``` | ||
| --- | ||
| ## <a name="faq"></a>FAQ | ||
@@ -232,3 +235,3 @@ | ||
| #### Are there any limits? | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 110 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 90 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
@@ -235,0 +238,0 @@ - Password protected PDFs |
+119
-116
| Metadata-Version: 2.1 | ||
| Name: api2pdf | ||
| Version: 0.0.8 | ||
| Version: 0.0.9 | ||
| Summary: Wrapper for api2pdf.com library for converting html, urls, and word documents to pdf | ||
@@ -9,24 +9,32 @@ Home-page: https://github.com/api2pdf/api2pdf.python | ||
| License: UNKNOWN | ||
| Description: # Api2Pdf - Python | ||
| [Api2Pdf.com](https://www.api2pdf.com) | [Docs](https://www.api2pdf.com/documentation) | ||
| Description: # api2pdf.python | ||
| Python bindings for [Api2Pdf REST API](https://www.api2pdf.com/documentation) | ||
| ## What is Api2Pdf? | ||
| Api2Pdf.com is a service for instantly generating PDFs. | ||
| Api2Pdf.com is a REST API for instantly generating PDF documents from HTML, URLs, Microsoft Office Documents (Word, Excel, PPT), and images. The API also supports merge / concatenation of two or more PDFs. Api2Pdf is a wrapper for popular libraries such as **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**. | ||
| - [Get Started](#get-started) | ||
| - [HTML](#convert-from-html) | ||
| - [URLs](#convert-from-urls) | ||
| - [Microsoft Office documents (Word, Excel, Powerpoint)](#convert-from-office) | ||
| - [Images](#convert-from-office) | ||
| - [Merge / Concatenate two or more PDFs](#merge) | ||
| - [Helper Methods](#helper-methods) | ||
| - [Installation](#installation) | ||
| - [Resources](#resources) | ||
| - [Authorization](#authorization) | ||
| - [Usage](#usage) | ||
| - [FAQ](#faq) | ||
| Api2Pdf provides access to **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**, along with the ability to merge / concatenate PDFs together. | ||
| ## <a name="installation"></a>Add a dependency | ||
| ### PyPI | ||
| ## <a name="get-started"></a>Get Started | ||
| This python library provides convenient methods for accessing the REST API [documented here](https://www.api2pdf.com/documentation/). | ||
| Run the pip command for installing the client `pip install api2pdf` | ||
| ## <a name="resources"></a>Resources | ||
| Resources this API supports: | ||
| - [wkhtmltopdf](#wkhtmltopdf) | ||
| - [Headless Chrome](#chrome) | ||
| - [LibreOffice](#libreoffice) | ||
| - [Merge / Concatenate PDFs](#merge) | ||
| - [Helper Methods](#helpers) | ||
| ## <a name="authorization"></a>Authorization | ||
| ### Acquire API Key | ||
@@ -36,17 +44,21 @@ 1. Create an account and login at [portal.api2pdf.com](https://portal.api2pdf.com) | ||
| 3. Create an application and grab your API Key | ||
| ### Install | ||
| pip install api2pdf | ||
| ### Usage | ||
| ## <a name="#usage"></a>Usage | ||
| ### Initialize the Client | ||
| All usage starts by calling the import command and initializing the client by passing your API key as a parameter to the constructor. | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| Once you initialize the client, you can make calls like so: | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response.result) | ||
| ### Sample Result | ||
| ### Result Object | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call. | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call, typically very small fractions of a penny. | ||
@@ -63,6 +75,5 @@ { | ||
| For debugging, you can simply print the `Api2PdfResponse` object to see the request and response data. | ||
| For debugging, you can print the `Api2PdfResponse` object to see the request and response data. | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response) | ||
@@ -73,6 +84,6 @@ | ||
| ---- API2PDF REQUEST ---- | ||
| - Headers: {'Authorization': 'f8bd6792-f1cd-42df-9bf9-f7a35e59362f'} | ||
| - Endpoint: https://v2018.api2pdf.com/merge | ||
| - Headers: {'Authorization': 'YOUR-API-KEY'} | ||
| - Endpoint: https://v2018.api2pdf.com/chrome/html | ||
| - Payload: | ||
| ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| {'html': '<p>Hello, World</p>'} | ||
| ---- API2PDF RESPONSE ---- | ||
@@ -82,75 +93,83 @@ {'pdf': 'https://link-to-pdf-only-available-for-24-hours', 'mbIn': 0.08421039581298828, 'mbOut': 0.08830547332763672, 'cost': 0.00017251586914062501, 'success': True, 'error': None, 'responseId': '163c4d25-25d7-4b82-bf50-907597d2ad46'} | ||
| ## Documentation | ||
| ### <a name="wkhtmltopdf"></a> wkhtmltopdf | ||
| ### <a name="convert-from-html"></a>Convert HTML to PDF | ||
| **Convert HTML to PDF** | ||
| We support both **wkhtmltopdf** and **Headless Chrome** with the endpoint to convert raw html to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| ##### HeadlessChrome.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| *Parameters:* | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', **options) | ||
| `html <string>` - raw string of html content | ||
| **Convert URL to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com') | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_html('<p>Hello World</p>') | ||
| print(headless_chrome_result.result) | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_html('<p>Hello World</p>') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| ### <a name="convert-from-url"></a>Convert URL to PDF | ||
| **Convert URL to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| We support both wkhtmltopdf and Headless Chrome with the endpoint to convert urls to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', **options) | ||
| ##### HeadlessChrome.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| --- | ||
| *Parameters:* | ||
| ## <a name="chrome"></a>Headless Chrome | ||
| `url <string>` - url to a pdf that Api2Pdf can consume | ||
| **Convert HTML to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', **options) | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| **Convert URL to PDF** | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(headless_chrome_result.result) | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| **Convert URL to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', **options) | ||
| ### <a name="convert-from-office"></a>Convert Microsoft Office Documents and Images to PDF | ||
| --- | ||
| We use **LibreOffice** to convert the following formats to PDF: | ||
| ## <a name="libreoffice"></a>LibreOffice | ||
| LibreOffice supports the conversion to PDF from the following file formats: | ||
| - doc, docx, xls, xlsx, ppt, pptx, gif, jpg, png, bmp, rtf, txt, html | ||
@@ -160,61 +179,45 @@ | ||
| ##### LibreOffice.convert_from_url(url, inline_pdf=False, file_name=None) | ||
| **Convert Microsoft Office Document or Image to PDF** | ||
| *Parameters:* | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx') | ||
| **Convert Microsoft Office Document or Image to PDF (load PDF in browser window and specify a file name)** | ||
| `url <string>` - url to a file of one of the supported formats above | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx', inline_pdf=True, file_name='test.pdf') | ||
| libreoffice_result = a2p.LibreOffice.convert_from_html('https://LINK-TO-YOUR-FILE') | ||
| print(libreoffice_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| ## <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| To use the merge endpoint, supply a list of urls to existing PDFs. The engine will consume all of the PDFs and merge them into a single PDF, in the order in which they were provided in the list. | ||
| ##### merge(list_of_urls, inline_pdf=False, file_name=None) | ||
| **Merge PDFs from list of URLs to existing PDFs** | ||
| *Paramaters:* | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| `list_of_urls <list>` - list of urls to pdfs | ||
| **Merge PDFs from list of URLs to existing PDFs (load PDF in browser window and specify a file name)** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs, inline_pdf=True, file_name='test.pdf') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| print(merge_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="helper-methods"></a>Helper Methods | ||
| ## <a name="helpers"></a>Helper Methods | ||
| ##### Api2PdfResponse: download_pdf() | ||
| **Api2PdfResponse: download_pdf()** | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy download_pdf() method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy `download_pdf()` method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| pdf_as_file_object = merge_result.download_pdf() | ||
| ``` | ||
| --- | ||
| ## <a name="faq"></a>FAQ | ||
@@ -232,3 +235,3 @@ | ||
| #### Are there any limits? | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 110 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 90 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
@@ -235,0 +238,0 @@ - Password protected PDFs |
+118
-115
@@ -1,23 +0,31 @@ | ||
| # Api2Pdf - Python | ||
| [Api2Pdf.com](https://www.api2pdf.com) | [Docs](https://www.api2pdf.com/documentation) | ||
| # api2pdf.python | ||
| Python bindings for [Api2Pdf REST API](https://www.api2pdf.com/documentation) | ||
| ## What is Api2Pdf? | ||
| Api2Pdf.com is a service for instantly generating PDFs. | ||
| Api2Pdf.com is a REST API for instantly generating PDF documents from HTML, URLs, Microsoft Office Documents (Word, Excel, PPT), and images. The API also supports merge / concatenation of two or more PDFs. Api2Pdf is a wrapper for popular libraries such as **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**. | ||
| - [Get Started](#get-started) | ||
| - [HTML](#convert-from-html) | ||
| - [URLs](#convert-from-urls) | ||
| - [Microsoft Office documents (Word, Excel, Powerpoint)](#convert-from-office) | ||
| - [Images](#convert-from-office) | ||
| - [Merge / Concatenate two or more PDFs](#merge) | ||
| - [Helper Methods](#helper-methods) | ||
| - [Installation](#installation) | ||
| - [Resources](#resources) | ||
| - [Authorization](#authorization) | ||
| - [Usage](#usage) | ||
| - [FAQ](#faq) | ||
| Api2Pdf provides access to **wkhtmltopdf**, **Headless Chrome**, and **LibreOffice**, along with the ability to merge / concatenate PDFs together. | ||
| ## <a name="installation"></a>Add a dependency | ||
| ### PyPI | ||
| ## <a name="get-started"></a>Get Started | ||
| This python library provides convenient methods for accessing the REST API [documented here](https://www.api2pdf.com/documentation/). | ||
| Run the pip command for installing the client `pip install api2pdf` | ||
| ## <a name="resources"></a>Resources | ||
| Resources this API supports: | ||
| - [wkhtmltopdf](#wkhtmltopdf) | ||
| - [Headless Chrome](#chrome) | ||
| - [LibreOffice](#libreoffice) | ||
| - [Merge / Concatenate PDFs](#merge) | ||
| - [Helper Methods](#helpers) | ||
| ## <a name="authorization"></a>Authorization | ||
| ### Acquire API Key | ||
@@ -27,17 +35,21 @@ 1. Create an account and login at [portal.api2pdf.com](https://portal.api2pdf.com) | ||
| 3. Create an application and grab your API Key | ||
| ### Install | ||
| pip install api2pdf | ||
| ### Usage | ||
| ## <a name="#usage"></a>Usage | ||
| ### Initialize the Client | ||
| All usage starts by calling the import command and initializing the client by passing your API key as a parameter to the constructor. | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| Once you initialize the client, you can make calls like so: | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response.result) | ||
| ### Sample Result | ||
| ### Result Object | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call. | ||
| An `Api2PdfResponse` object is returned from every API call. Call the `result` attribute to retrieve the data. If a call is unsuccessful then `success` will show False and the `error` will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call, typically very small fractions of a penny. | ||
@@ -54,6 +66,5 @@ { | ||
| For debugging, you can simply print the `Api2PdfResponse` object to see the request and response data. | ||
| For debugging, you can print the `Api2PdfResponse` object to see the request and response data. | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| print(api_response) | ||
@@ -64,6 +75,6 @@ | ||
| ---- API2PDF REQUEST ---- | ||
| - Headers: {'Authorization': 'f8bd6792-f1cd-42df-9bf9-f7a35e59362f'} | ||
| - Endpoint: https://v2018.api2pdf.com/merge | ||
| - Headers: {'Authorization': 'YOUR-API-KEY'} | ||
| - Endpoint: https://v2018.api2pdf.com/chrome/html | ||
| - Payload: | ||
| ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| {'html': '<p>Hello, World</p>'} | ||
| ---- API2PDF RESPONSE ---- | ||
@@ -73,75 +84,83 @@ {'pdf': 'https://link-to-pdf-only-available-for-24-hours', 'mbIn': 0.08421039581298828, 'mbOut': 0.08830547332763672, 'cost': 0.00017251586914062501, 'success': True, 'error': None, 'responseId': '163c4d25-25d7-4b82-bf50-907597d2ad46'} | ||
| ## Documentation | ||
| ### <a name="wkhtmltopdf"></a> wkhtmltopdf | ||
| ### <a name="convert-from-html"></a>Convert HTML to PDF | ||
| **Convert HTML to PDF** | ||
| We support both **wkhtmltopdf** and **Headless Chrome** with the endpoint to convert raw html to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| ##### HeadlessChrome.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_html(html, inline_pdf=False, file_name=None, **options) | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| *Parameters:* | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', **options) | ||
| `html <string>` - raw string of html content | ||
| **Convert URL to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com') | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_html('<p>Hello World</p>') | ||
| print(headless_chrome_result.result) | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_html('<p>Hello World</p>') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| ### <a name="convert-from-url"></a>Convert URL to PDF | ||
| **Convert URL to PDF (use keyword arguments for advanced wkhtmltopdf settings)** | ||
| [View full list of wkhtmltopdf options available.](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| We support both wkhtmltopdf and Headless Chrome with the endpoint to convert urls to PDFs. Both endpoints allow you to pass keyword arguments that are options available for their respective libraries. | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', **options) | ||
| ##### HeadlessChrome.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| ##### WkHtmlToPdf.convert_from_url(url, inline_pdf=False, file_name=None, **options) | ||
| --- | ||
| *Parameters:* | ||
| ## <a name="chrome"></a>Headless Chrome | ||
| `url <string>` - url to a pdf that Api2Pdf can consume | ||
| **Convert HTML to PDF** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>') | ||
| **Convert HTML to PDF (load PDF in browser window and specify a file name)** | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf') | ||
| **Convert HTML to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| `**options <keyword args> (optional, default=None)` - include options for generating a PDF with your chosen library. See available options here: | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', **options) | ||
| - [wkhtmltopdf options](https://www.api2pdf.com/documentation/advanced-options-wkhtmltopdf/) | ||
| - [headless chrome options](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| **Convert URL to PDF** | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com') | ||
| # headless chrome | ||
| headless_chrome_result = a2p.HeadlessChrome.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(headless_chrome_result.result) | ||
| **Convert URL to PDF (load PDF in browser window and specify a file name)** | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf') | ||
| # wkhtmltopdf | ||
| wkhtmltopdf_result = a2p.WkHtmlToPdf.convert_from_url('https://LINK-TO-YOUR-WEBSITE') | ||
| print(wkhtmltopdf_result.result) | ||
| ``` | ||
| **Convert URL to PDF (use keyword arguments for advanced Headless Chrome settings)** | ||
| [View full list of Headless Chrome options available.](https://www.api2pdf.com/documentation/advanced-options-headless-chrome/) | ||
| options = { | ||
| 'orientation': 'landscape', | ||
| 'pageSize': 'A4' | ||
| } | ||
| api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', **options) | ||
| ### <a name="convert-from-office"></a>Convert Microsoft Office Documents and Images to PDF | ||
| --- | ||
| We use **LibreOffice** to convert the following formats to PDF: | ||
| ## <a name="libreoffice"></a>LibreOffice | ||
| LibreOffice supports the conversion to PDF from the following file formats: | ||
| - doc, docx, xls, xlsx, ppt, pptx, gif, jpg, png, bmp, rtf, txt, html | ||
@@ -151,61 +170,45 @@ | ||
| ##### LibreOffice.convert_from_url(url, inline_pdf=False, file_name=None) | ||
| **Convert Microsoft Office Document or Image to PDF** | ||
| *Parameters:* | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx') | ||
| **Convert Microsoft Office Document or Image to PDF (load PDF in browser window and specify a file name)** | ||
| `url <string>` - url to a file of one of the supported formats above | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx', inline_pdf=True, file_name='test.pdf') | ||
| libreoffice_result = a2p.LibreOffice.convert_from_html('https://LINK-TO-YOUR-FILE') | ||
| print(libreoffice_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| ## <a name="merge"></a>Merge / Concatenate Two or More PDFs | ||
| To use the merge endpoint, supply a list of urls to existing PDFs. The engine will consume all of the PDFs and merge them into a single PDF, in the order in which they were provided in the list. | ||
| ##### merge(list_of_urls, inline_pdf=False, file_name=None) | ||
| **Merge PDFs from list of URLs to existing PDFs** | ||
| *Paramaters:* | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| `list_of_urls <list>` - list of urls to pdfs | ||
| **Merge PDFs from list of URLs to existing PDFs (load PDF in browser window and specify a file name)** | ||
| `inline_pdf <bool> (optional, default=False)` - if set to True, web browser will load the PDF in a new tab. | ||
| `file_name <string> (optional, default=None)` - specify an optional file name like "report-03012019.pdf". | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p_client.merge(links_to_pdfs, inline_pdf=True, file_name='test.pdf') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| print(merge_result.result) | ||
| ``` | ||
| --- | ||
| ### <a name="helper-methods"></a>Helper Methods | ||
| ## <a name="helpers"></a>Helper Methods | ||
| ##### Api2PdfResponse: download_pdf() | ||
| **Api2PdfResponse: download_pdf()** | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy download_pdf() method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| On any `Api2PdfResponse` that succesfully generated a pdf, you can use the handy `download_pdf()` method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException. | ||
| ``` | ||
| from api2pdf import Api2Pdf | ||
| a2p = Api2Pdf('YOUR-API-KEY') | ||
| a2p_client = Api2Pdf('YOUR-API-KEY') | ||
| # merge pdfs | ||
| links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF'] | ||
| merge_result = a2p.merge(links_to_pdfs) | ||
| merge_result = a2p_client.merge(links_to_pdfs) | ||
| pdf_as_file_object = merge_result.download_pdf() | ||
| ``` | ||
| --- | ||
| ## <a name="faq"></a>FAQ | ||
@@ -223,3 +226,3 @@ | ||
| #### Are there any limits? | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 110 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
| Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 90 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are: | ||
@@ -226,0 +229,0 @@ - Password protected PDFs |
+1
-1
@@ -8,3 +8,3 @@ import setuptools | ||
| name="api2pdf", | ||
| version="0.0.8", | ||
| version="0.0.9", | ||
| author="Zack Schwartz", | ||
@@ -11,0 +11,0 @@ author_email="support@api2pdf.com", |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Improved metrics
- Total package byte prevSize
40701
1.79%