Python file converter library for Zamzar

Easy to use Python file conversion API with support for 2.0.0+ file conversions - convert documents, audio, images, video, eBooks and more. Use zamzar-python to convert files between different formats as part of your Python application with the Zamzar file conversion API. Common use cases include:

• Convert Microsoft Word (DOCX, DOC) to PDF
• Convert Powerpoint (PPT, PPTX) to JPG
• Extract text from PDF files
• Archive email (MSG files) to PDF

This is the official Python SDK for the Zamzar API.

Jump to:

• Requirements
• Installation
• Usage
• Resources

Requirements

• Before you begin, signup for a Zamzar API Account or retrieve your existing API Key from the Zamzar Developers Homepage
• Python 3.11 and later. (See Compatibility for more information).

Installation

You can install the Zamzar Python SDK using pip:

pip install --upgrade zamzar

Usage

Getting Started

Please follow the installation instructions and execute the following Python code:

from zamzar import ZamzarClient

zamzar = ZamzarClient("YOUR_API_KEY_GOES_HERE")

zamzar.convert("/tmp/example.docx", "pdf").store("/tmp/").delete_all_files()

See the examples to learn more about how to use the Zamzar Python SDK.

Using the sandbox environment

Whilst developing your application, you can use the lZamzar sandbox environment to test your code without consuming production credits:

from zamzar import ZamzarClient, Environment

zamzar = ZamzarClient("YOUR_API_KEY_GOES_HERE", environment=Environment.SANDBOX)

The Zamzar Python SDK uses the production environment by default, but you can also specify it explicitly:

from zamzar import ZamzarClient, Environment

zamzar = ZamzarClient("YOUR_API_KEY_GOES_HERE", environment=Environment.PRODUCTION)

Logging

By default, the Zamzar Python SDK does not log HTTP requests and responses. To enable logging, configure a logging.Logger for urllib3:

import logging

from zamzar import ZamzarClient

# Configure logging as needed. Here we configure a simple console logger
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)  # Set the logging level for the console handler
console_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(console_formatter)
root_logger = logging.getLogger()
root_logger.addHandler(console_handler)
logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# Enable logging for urllib3 to see HTTP requests
urllib3_logger = logging.getLogger('urllib3')
urllib3_logger.setLevel(logging.DEBUG)

# Make a request to the Zamzar API
zamzar = ZamzarClient("YOUR_API_KEY_GOES_HERE")
zamzar.account.get()

Configuring timeouts and retries

The Zamzar Python SDK will automatically:

• time out long-running requests
• retry requests that fail or time out

The default settings are defined in ZamzarClient.

To override these defaults, configure your own urllib3.Retry and pass it to the ZamzarClient constructor:

import urllib3

from zamzar import ZamzarClient

# Configure a custom retry policy
custom_policy = urllib3.Retry(
    total=5,  # Maximum number of retries
    backoff_factor=1,  # Exponential backoff factor
    backoff_max=60,  # Maximum backoff time
    status_forcelist=[429, 502, 503, 504],  # HTTP status codes to retry
    allowed_methods=None  # retry all request methods
)

# Make a request to the Zamzar API
zamzar = ZamzarClient("YOUR_API_KEY_GOES_HERE", retries=custom_policy)

Resources

Code Samples - Copy/Paste from examples which demonstrate all key areas of functionality.

Developer Docs - For more information about API operations, parameters, and responses. Use this if you need additional context on all areas of functionality.

Compatibility

This SDK requires Python 3.11 or later. Earlier SDK versions support older Python versions (see below), but those SDK releases are no longer maintained. We encourage you to upgrade to a supported Python and SDK version wherever possible.