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.69.tar.gz (397.3 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.69-py3-none-any.whl (455.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scoutsdk-0.1.69.tar.gz
  • Upload date:
  • Size: 397.3 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.69.tar.gz
Algorithm Hash digest
SHA256 5b2acca893c5c9db75c8ec21d8b2a1f612965d7677ec974353e926f5b6ec2d8a
MD5 b8a6fd90797340f63719a1bc292f14a6
BLAKE2b-256 f7ad8e09f297df8ea328189eb607a818f137e37a26c290e04b305e84359b3dfb

See more details on using hashes here.

Provenance

The following attestation bundles were made for scoutsdk-0.1.69.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.69-py3-none-any.whl.

File metadata

  • Download URL: scoutsdk-0.1.69-py3-none-any.whl
  • Upload date:
  • Size: 455.7 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.69-py3-none-any.whl
Algorithm Hash digest
SHA256 67379b5089a6140da45befb9eaeaebdb07a64420e55c17836f591742785e6ca5
MD5 e29d893dfde287ccd4657a3a51d1566b
BLAKE2b-256 b2707be7deddeda1cff03af184f76bf22aba406cd6d404645524fe81cffc4575

See more details on using hashes here.

Provenance

The following attestation bundles were made for scoutsdk-0.1.69-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