Skip to main content

Python package for scoutsdk

Project description

Scout SDK Package

Helper python package to interact with the Scout platform.

Installation

pip install scoutsdk

Usage

from scoutsdk import ScoutAPI

scout = ScoutAPI(base_url="your_scout_base_url", api_access_token="you_api_access_token")

Retry Logic

The SDK automatically retries failed API requests with exponential backoff to handle transient failures. This improves reliability when dealing with network issues or temporary server problems.

Default Behavior

  • Max attempts: 3 (initial request + 2 retries)
  • Wait time: Exponential backoff with multiplier=1, min=4s, max=10s
  • Retry on:
    • Rate limiting (429)
    • Server errors (500, 502, 503, 504)
    • Network errors (ConnectionError, Timeout)
  • Does NOT retry on:
    • Client errors (400, 401, 403, 404, etc.)
    • Successful responses

How It Works

All HTTP methods (GET, POST, PUT, DELETE, PATCH) in the SDK automatically retry on transient failures:

from scoutsdk import ScoutAPI

scout = ScoutAPI(base_url="your_url", api_access_token="your_token")

# This request will automatically retry up to 3 times on 5xx errors
response = scout.chat.completion(messages="Hello!")

The retry logic is transparent - you don't need to change your code. If a request fails with a retryable error, the SDK will:

  1. Wait with exponential backoff (4s, then 8s, then 10s max)
  2. Retry the request
  3. Return the result if successful, or raise the exception after exhausting retries

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scoutsdk-0.1.64.tar.gz (391.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scoutsdk-0.1.64-py3-none-any.whl (451.1 kB view details)

Uploaded Python 3

File details

Details for the file scoutsdk-0.1.64.tar.gz.

File metadata

  • Download URL: scoutsdk-0.1.64.tar.gz
  • Upload date:
  • Size: 391.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scoutsdk-0.1.64.tar.gz
Algorithm Hash digest
SHA256 13f3004537864789cac37dc9af810a9ad60519e7fe38e903d22a3d8197a42705
MD5 5d298fe9b950a84e344b60514d1b74cc
BLAKE2b-256 ba0e342a19046172dee4b0ab23e9578ca6aafe6efb3c84579944f123ab23b57a

See more details on using hashes here.

Provenance

The following attestation bundles were made for scoutsdk-0.1.64.tar.gz:

Publisher: publish-python-sdk.yml on mirego/mirego-scout

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scoutsdk-0.1.64-py3-none-any.whl.

File metadata

  • Download URL: scoutsdk-0.1.64-py3-none-any.whl
  • Upload date:
  • Size: 451.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scoutsdk-0.1.64-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b431580595a98b1fd5935b06458e7b003fd41bf7cb207be8e9edc9269b0826
MD5 65f9105b7d9ab34bc15e30e0d99224b3
BLAKE2b-256 7e37b08845322737fc499518820d2c5ef0f56f5c1bf94d54a72a1b3cd4f1a08d

See more details on using hashes here.

Provenance

The following attestation bundles were made for scoutsdk-0.1.64-py3-none-any.whl:

Publisher: publish-python-sdk.yml on mirego/mirego-scout

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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