This release is a pre-release and may not be stable for production use.
Truefoundry Python Library
This library provides convenient access to the TrueFoundry API.
Table of Contents
Installation
pip install truefoundry-sdk
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from truefoundry_sdk import TrueFoundry
client = TrueFoundry(
api_key="<token>",
base_url="https://yourhost.com/path/to/api",
)
client.applications.list(
limit=10,
offset=0,
)
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 truefoundry_sdk import AsyncTrueFoundry
client = AsyncTrueFoundry(
api_key="<token>",
base_url="https://yourhost.com/path/to/api",
)
async def main() -> None:
await client.applications.list(
limit=10,
offset=0,
)
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 truefoundry_sdk.core.api_error import ApiError
try:
client.applications.list(...)
except ApiError as e:
print(e.status_code)
print(e.body)
Pagination
Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.
from truefoundry_sdk import TrueFoundry
client = TrueFoundry(
api_key="<token>",
base_url="https://yourhost.com/path/to/api",
)
client.applications.list(
limit=10,
offset=0,
)
# You can also iterate through pages and access the typed response per page
pager = client.applications.list(...)
for page in pager.iter_pages():
print(page.response) # access the typed response for each page
for item in page:
print(item)
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 truefoundry_sdk import TrueFoundry
client = TrueFoundry(
...,
)
pager = client.applications.list(...)
print(pager.response) # access the typed response for the first page
for item in pager:
print(item) # access the underlying object(s)
for page in pager.iter_pages():
print(page.response) # access the typed response for each page
for item in page:
print(item) # 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).
Which status codes are retried depends on the retryStatusCodes generator configuration:
legacy (current default): retries on
recommended: retries on
- 408 (Timeout)
- 409 (Conflict)
- 429 (Too Many Requests)
- 502 (Bad Gateway)
- 503 (Service Unavailable)
- 504 (Gateway Timeout)
Use the max_retries request option to configure this behavior.
client.applications.list(..., 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 truefoundry_sdk import TrueFoundry
client = TrueFoundry(..., timeout=20.0)
# Override timeout for a specific method
client.applications.list(..., request_options={
"timeout": 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 truefoundry_sdk import TrueFoundry
client = TrueFoundry(
...,
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!
1 maintainer
Metadata
1 maintainer
Release files for truefoundry-sdk 0.6.0rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| truefoundry_sdk-0.6.0rc1.tar.gz | 459.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| truefoundry_sdk-0.6.0rc1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / truefoundry_sdk-0.6.0rc1.tar.gz
| Download URL | truefoundry_sdk-0.6.0rc1.tar.gz |
|---|---|
| Size | 459.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a239c2abacca1fca8ee1eee10348e9eac902d96d4746fd7ada18ea50e2afabbc
|
|
BLAKE2b-256 checksum How to use checksums |
371c40d9d804900d4b8ff584b641b681e142dee42d920b4b2bbf248a3d24a266
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.8.0-1064-azure
|
Release files / truefoundry_sdk-0.6.0rc1-py3-none-any.whl
| Download URL | truefoundry_sdk-0.6.0rc1-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
57549914ddf9815f5ec08345a197c2139a229a3223b1bbe61e5bb26898a2aa00
|
|
BLAKE2b-256 checksum How to use checksums |
205cca2f1d10bbde7a7b451e21bb7dc91c2a2fc100a7dee584aaae1b70dc2207
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.8.0-1064-azure
|
