Frameio Python Library
The Frameio Python library provides convenient access to the Frameio APIs from Python.
Table of Contents
Installation
pip install frameio-experimental
Reference
A full reference for this library is available here.
Usage
Instantiate and use the client with the following:
from frameio_experimental import FrameioExperimental
from frameio_experimental.search import SearchParamsFilters, SearchParamsScope
client = FrameioExperimental(
token="<token>",
)
client.search.search(
account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
after="<opaque_cursor>",
page_size=10,
include_total_count=False,
engine="nlp",
filters=SearchParamsFilters(
files_and_version_stacks=True,
folders=False,
projects=False,
),
query="red car driving on highway",
scope=SearchParamsScope(
folder_id="eac8f1bf-56a4-4f48-8352-17f730665d76",
),
)
Environments
This SDK allows you to configure different environments for API requests.
from frameio_experimental import FrameioExperimental
from frameio_experimental.environment import FrameioExperimentalEnvironment
client = FrameioExperimental(
environment=FrameioExperimentalEnvironment.DEFAULT,
)
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 frameio_experimental.search import SearchParamsFilters, SearchParamsScope
from frameio_experimental import AsyncFrameioExperimental
client = AsyncFrameioExperimental(
token="<token>",
)
async def main() -> None:
await client.search.search(
account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
after="<opaque_cursor>",
page_size=10,
include_total_count=False,
engine="nlp",
filters=SearchParamsFilters(
files_and_version_stacks=True,
folders=False,
projects=False,
),
query="red car driving on highway",
scope=SearchParamsScope(
folder_id="eac8f1bf-56a4-4f48-8352-17f730665d76",
),
)
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 frameio_experimental.core.api_error import ApiError
try:
client.search.search(...)
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 frameio_experimental import FrameioExperimental
client = FrameioExperimental(...)
response = client.search.with_raw_response.search(...)
print(response.headers) # access the response headers
print(response.status_code) # access the response status code
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).
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.search.search(..., 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 frameio_experimental import FrameioExperimental
client = FrameioExperimental(..., timeout=20.0)
# Override timeout for a specific method
client.search.search(..., 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 frameio_experimental import FrameioExperimental
client = FrameioExperimental(
...,
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!
4 maintainers
Release files for frameio-experimental 10.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| frameio_experimental-10.0.2.tar.gz | 205.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| frameio_experimental-10.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 687.2 kB
Release files / frameio_experimental-10.0.2.tar.gz
| Download URL | frameio_experimental-10.0.2.tar.gz |
|---|---|
| Size | 205.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
789c66997e42d3da91102159cb8c058b56a598d1a55b60f6cdb05be4f1fb1449
|
|
BLAKE2b-256 checksum How to use checksums |
100b9576454a55b47201d9d93335132c6cdc073e2c6cce75558a348fada7ad03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
Release files / frameio_experimental-10.0.2-py3-none-any.whl
| Download URL | frameio_experimental-10.0.2-py3-none-any.whl |
|---|---|
| Size | 482.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a4e9292bf7280a9ab6ea6efeb0556b4ef2063dc7dc112299e39e087a3e27f62e
|
|
BLAKE2b-256 checksum How to use checksums |
1888c99e186a9ff32802b67909db649644a7e7230a3c52f02903804a8435d765
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure
|
