foru-ms-sdk 0.0.24

No project description provided

Foru.ms Python Library

The Foru.ms Python library provides convenient access to the Foru.ms APIs from Python.

Table of Contents

• Documentation
• Installation
• Reference
• Usage
• Async Client
• Exception Handling
• Advanced
  • Access Raw Response Data
  • Retries
  • Timeouts
  • Custom Client

Documentation

API reference documentation is available here.

Installation

pip install foru-ms-sdk

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from foru_ms_sdk import ForumClient

client = ForumClient(
    api_key="YOUR_API_KEY",
)
client.auth.register(
    username="username",
    email="email",
    password="password",
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from foru_ms_sdk import AsyncForumClient

client = AsyncForumClient(
    api_key="YOUR_API_KEY",
)


async def main() -> None:
    await client.auth.register(
        username="username",
        email="email",
        password="password",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from foru_ms_sdk.core.api_error import ApiError

try:
    client.auth.register(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from foru_ms_sdk import ForumClient

client = ForumClient(
    ...,
)
response = client.auth.with_raw_response.register(...)
print(response.headers)  # access the response headers
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retryable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.auth.register(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from foru_ms_sdk import ForumClient

client = ForumClient(
    ...,
    timeout=20.0,
)


# Override timeout for a specific method
client.auth.register(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from foru_ms_sdk import ForumClient

client = ForumClient(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)