HTML to PDF is a simple tool for converting HTML to PDF. It returns the PDF file generated from the HTML.

Project description

HTML to PDF API

HTML to PDF is a simple tool for converting HTML to PDF. It returns the PDF file generated from the HTML.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the HTML to PDF API

Installation

pip install apiverve-htmltopdf

Configuration

Before using the htmltopdf API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com

Usage

The HTML to PDF API documentation is found here: https://docs.apiverve.com/api/htmltopdf.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_htmltopdf.apiClient import HtmltopdfAPIClient

# Initialize the client with your APIVerve API key
api = HtmltopdfAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query

query = {  "marginTop": 0.4,  "marginBottom": 0.4,  "marginLeft": 0.4,  "marginRight": 0.4,  "landscape": false,  "html": "<!doctype html> <html> <head> <title>This is the title of the webpage!</title> </head> <body> <p>This is an example paragraph. Anything in the <strong>body</strong> tag will appear on the page, just like this <strong>p</strong> tag and its contents.</p> </body> </html>" }

Simple Request

# Make a request to the API
result = api.execute(query)

# Print the result
print(result)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "marginLeft": "0.4in",
    "marginRight": "0.4in",
    "marginTop": "0.4in",
    "marginBottom": "0.4in",
    "landscape": false,
    "pdfName": "0edcc51a-3c6b-4eac-8761-b41a4919f7f4.pdf",
    "expires": 1725355755108,
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/htmltopdf/0edcc51a-3c6b-4eac-8761-b41a4919f7f4.pdf?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725355755&Signature=BBWhYzDCBXS%2FpRQrKgIAmt3%2F7gwO599vyNGOTXBdUtbONGpV7FNldgJnoIK6h3pip3%2FCDDaNoeuXJbC1wZ2ZamJ4qYc0S2TqivAN3wAMoPnfeKpenWEWLqvROHQJdCSwil43u7oB1FUCDRfzxGpPmgjGJBXgmBNwO1k%2BTNNEYxl2M3QHlAT%2BbVlGLlrRHWaRN6WWPKYhEMFQNcNA1djGTfBRReAbr%2FpX44QG9FnJFZ3wQg%2BS4Z8jTpnzXXVJBcIHJ0tVhzsj6HpLQmq43BRYsI7wmMeKNT5ooyYjDQGt%2BShKN4HNSddMKDxElpUSBXFhARoWQm0S8JJfX0aCzubttw%3D%3D"
  },
  "code": 200
}

Customer Support

Need any assistance? Get in touch with Customer Support.

Updates

Stay up to date by following @apiverveHQ on Twitter.

Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.

License

Licensed under the The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details

Release history Release notifications | RSS feed

This version

1.1.5

Sep 21, 2024

1.1.4

Aug 20, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_htmltopdf-1.1.5.tar.gz (8.2 kB view details)

Uploaded Sep 21, 2024 Source

Built Distribution

apiverve_htmltopdf-1.1.5-py3-none-any.whl (7.8 kB view details)

Uploaded Sep 21, 2024 Python 3

File details

Details for the file apiverve_htmltopdf-1.1.5.tar.gz.

File metadata

Download URL: apiverve_htmltopdf-1.1.5.tar.gz
Upload date: Sep 21, 2024
Size: 8.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for apiverve_htmltopdf-1.1.5.tar.gz
Algorithm	Hash digest
SHA256	`0dfa9f7984f18d2c214913f2bd75cb7fe40b4cba636f772b935c06930ceae88b`
MD5	`0c22a4716ffa19706e5a377f46fb5499`
BLAKE2b-256	`eeaccb9f175c222ec315859a2df70b54df32415739662bfdd05fc760413aae65`

See more details on using hashes here.

File details

Details for the file apiverve_htmltopdf-1.1.5-py3-none-any.whl.

File metadata

Download URL: apiverve_htmltopdf-1.1.5-py3-none-any.whl
Upload date: Sep 21, 2024
Size: 7.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for apiverve_htmltopdf-1.1.5-py3-none-any.whl
Algorithm	Hash digest
SHA256	`0caf2d20339dde0d76fe514fe7f622242a041c7fc3a21fa5c757ad8fea19d5c8`
MD5	`2be032b9db0b05ccde473da7975becad`
BLAKE2b-256	`09e69fa2c1f44e885f3f66e30bedca05dbfa40e8a0d12134b4d1df2e76f8b0eb`