DirectPublishingTest Python SDK 1.0.0

Welcome to the DirectPublishingTest SDK documentation. This guide will help you get started with integrating and using the DirectPublishingTest SDK in your project.

Versions

• SDK version: 1.0.0

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.9

Installation

To get started with the SDK, we recommend installing using pip:

pip install pm-ahamot-direct-publishing-test

If you are using Python 3, you can use pip3 instead:

pip3 install pm-ahamot-direct-publishing-test

Disabling Redirects

By default, the SDK follows HTTP redirects (3xx responses) automatically. Pass follow_redirects=False to get the redirect response back as-is instead:

client = DirectPublishingTest(follow_redirects=False)

This can also be changed later with client.set_follow_redirects(False).

Logging

The SDK is silent by default. Pass a standard library logging.Logger as logger to log every outgoing request and its response (method, URL, status, and duration):

import logging

logger = logging.getLogger("DirectPublishingTest")
logger.setLevel(logging.INFO)
logger.addHandler(logging.StreamHandler())

client = DirectPublishingTest(logger=logger)

This can also be changed later with client.set_logging(logger).

Authorization and Cookie header values are always redacted in logged output, regardless of the logger's own configuration.

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from direct_publishing_test import DirectPublishingTest

sdk = DirectPublishingTest(timeout=10)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from direct_publishing_test import DirectPublishingTest

sdk = DirectPublishingTest(
    timeout=10
)

result = sdk.widgets.get_widget(widget_id="widgetId")

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from direct_publishing_test import DirectPublishingTestAsync

sdk = DirectPublishingTestAsync(
    timeout=10
)


async def main():
  result = await sdk.widgets.get_widget(widget_id="widgetId")
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.