Skip to main content

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": "bb735c6b-83de-49d0-8153-1c9e4bdb7fbc.pdf",
    "expires": 1723788930036,
    "downloadURL": "https://storage.googleapis.com/apiverve.appspot.com/htmltopdf/bb735c6b-83de-49d0-8153-1c9e4bdb7fbc.pdf?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1723788930&Signature=VwcU0l%2FF1xCxUB4Ux5byIVEOU2I%2FA89h9%2B%2FNt0JzKx3ZLsBAvmbI%2BtqNCGhCPUoJxA1jMxwW7cfpV5bF88oaUlVL%2BEl2Ndpw%2FuOB3J0n9r3nEKi06RPjGcKpnzuHFh10G1qCfI4bDN%2BpyuXP6Gn%2FhhvpdquE8YAWGitC2Q4zCDHItpcYvgxkyK%2BhuijpEOUALYCI4oi5NdB4d01gBjmyHi0JkD4qC4INsaMVulM54QxWCDpdQOufxuiJ6C1xONvDXFPAHhZGRTMdNrXRxOVSp6OIvqXK3QmQJwI6EYmc5Y5oUxNl%2BDRdep%2Fk2PO9kOGhqZ7SnO2P8%2Bkqe5NvsDu9%2Bw%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)

Copyright (©) 2024 APIVerve, and Evlar LLC

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.

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.4.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

apiverve_htmltopdf-1.1.4-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apiverve_htmltopdf-1.1.4.tar.gz
  • Upload date:
  • Size: 8.0 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.4.tar.gz
Algorithm Hash digest
SHA256 5ce73de51b45a34f6b9cb05f38b24d6f3226dbdedb6144c7842a7032038bcbab
MD5 f3133f8226ba0a55050bb5d2994c7ad5
BLAKE2b-256 a86883aca798bc80d368dbaeb91b4567dc6c439d6b12ac70926e0556a8516af3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_htmltopdf-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fc1fc9838138093a0654c8a853984d1f267dc0d28db11bc34ff9f38bc13cad54
MD5 be5897fd7a629085666fe398dc339672
BLAKE2b-256 e25255e7d729696767074eded9cc519b7eef05df333ff69929d1e8037db17ebb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page