View all our code samples

Using Aiohttp in Python

Aiohttp is an asynchronous HTTP client/server framework for Python. It allows developers to write asynchronous web servers and clients using Python's asyncio library. aiohttp provides a high-level API for making HTTP requests and handling responses asynchronously, making it suitable for high-performance networking applications and web services.

We've implemented a code sample that you can re-use to convert your HTML documents to PDF, JPG, PNG or WEBP using PDFShift and Python:

import aiohttp
import asyncio
import base64
import json

async def convert(api_key, params, endpoint='pdf'):
    We focused on making this function as simple as possible.
    Since PDFShift is a REST API, we just need to send a
    POST request to the endpoint by passing a set of custom parameters.
        api_key (str): Your API key.
        params (dict): A dictionary containing the parameters
                       you want to send to the API.
        endpoint (str): The type of conversion you want to perform
                        (pdf, png, jpg, webp)
        bytes | dict: Either the binary content of the PDF
                      or a dictionary containing the details
                      when filename/webhook are passed
    assert endpoint in ('pdf', 'png', 'jpg', 'webp')
    auth = base64.b64encode(
        async with aiohttp.ClientSession() as session:
            async with
                headers={'Authorization': f'Basic {auth}'},
            ) as response:
                if response.status >= 400:
                    raise Exception('Invalid request: {}'.format(await response.text()))
                if 'filename' in params or 'webhook' in params:
                    return json.loads(await response.text())
                return await
    except asyncio.TimeoutError:
        raise Exception('The request took too long to process')
    except aiohttp.ClientError as e:
        raise Exception(f'An error occurred: {e}')
    except Exception as e:
        # We highly recommend you to handle exceptions. Often, PDFShift will provide you with a clear explanation about what happened.
        # Moreover, in case of error, no PDF are returned !
        raise Exception(f'An error occurred: {e}')

Here's how you can use the above code:

binary = await convert('sk_XXXXXXXXXXXXXX', {'source': ''})
with open('result.pdf', 'wb') as f:

We've tested this code with the latest version of Aiohttp and it's ready to be used in your project.

But if you were to encounter any bugs or issues while running it (or if you want to suggest changes to improve the code), please contact us and we'll be happy to help you out.