Scoutos Python Library
The Scoutos Python library provides convenient access to the Scoutos APIs from Python.
Table of Contents
Installation
pip install scoutos
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from scoutos import Scout
client = Scout(
api_key="YOUR_API_KEY",
)
client.workflows.create_revision(
workflow_id="workflow_id",
workflow_key="workflow_key",
)
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 scoutos import AsyncScout
client = AsyncScout(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.workflows.create_revision(
workflow_id="workflow_id",
workflow_key="workflow_key",
)
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 scoutos.core.api_error import ApiError
try:
client.workflows.create_revision(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Streaming
The SDK supports streaming responses, as well, the response will be a generator that you can loop over.
from scoutos import Scout
client = Scout(
api_key="YOUR_API_KEY",
)
response = client.workflows.run_stream(
workflow_id="workflow_id",
environment="environment",
revision_id="revision_id",
session_id="session_id",
)
for chunk in response.data:
yield chunk
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 scoutos import Scout
client = Scout(
...,
)
response = client.workflows.with_raw_response.create_revision(...)
print(response.headers) # access the response headers
print(response.data) # access the underlying object
with client.workflows.with_raw_response.run_stream(...) as response:
print(response.headers) # access the response headers
for chunk in response.data:
print(chunk) # access the underlying object(s)
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:
Use the max_retries request option to configure this behavior.
client.workflows.create_revision(..., 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 scoutos import Scout
client = Scout(
...,
timeout=20.0,
)
# Override timeout for a specific method
client.workflows.create_revision(..., 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 scoutos import Scout
client = Scout(
...,
httpx_client=httpx.Client(
proxy="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
2 maintainers
Metadata
2 maintainers
Release files for scoutos 12.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| scoutos-12.3.0.tar.gz | 166.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scoutos-12.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 657.1 kB
Release files / scoutos-12.3.0.tar.gz
| Download URL | scoutos-12.3.0.tar.gz |
|---|---|
| Size | 166.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b921cd77eeee917dfd03b38333164fe7e39aaac64cf288a6f4ed0dce661ac27a
|
|
BLAKE2b-256 checksum How to use checksums |
3cd0cc594e8594b5012f370ec7a3a87c8923b537a6c38dcb04651dc68089f810
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.17.0-1018-azure
|
Release files / scoutos-12.3.0-py3-none-any.whl
| Download URL | scoutos-12.3.0-py3-none-any.whl |
|---|---|
| Size | 490.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28313702b06eab88698b13d8416f0567096342941f2c10f64cbc3f321d4cfe3c
|
|
BLAKE2b-256 checksum How to use checksums |
70696a71f0333a4cc5c4fe9326e9c673b5eeca1ec086f48d9f45327edf00957a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.17.0-1018-azure
|
Security for scoutos 12.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
