Skip to main content

Frameio Python Library

fern shield pypi

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="876f6e6d-69b4-4cb0-85bc-79f202640078",
    ),
)

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="876f6e6d-69b4-4cb0-85bc-79f202640078",
        ),
    )


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

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

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!

Metadata

Release files for frameio-experimental 12.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for frameio-experimental 12.0.1
File Size Uploaded Provenance Actions
frameio_experimental-12.0.1.tar.gz 205.3 kB Without provenance Details for frameio_experimental-12.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for frameio-experimental 12.0.1
File Interpreter ABI Platform Actions
frameio_experimental-12.0.1-py3-none-any.whl Python 3 none any Details for frameio_experimental-12.0.1-py3-none-any.whl

Total release size: 690.7 kB

Release files / frameio_experimental-12.0.1.tar.gz

Download URL frameio_experimental-12.0.1.tar.gz
Size 205.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d4ef8c0032391027d3dd8b53d81537f28e31fb94cb2a2ed151e4ad17bc6debf5
BLAKE2b-256 checksum
How to use checksums
c9f16fcf6325e6df9b1f561fa200d59ba7dfc37be43aece19ba0a4317e975bdb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.22 Linux/7.0.0-1019-azure

Release files / frameio_experimental-12.0.1-py3-none-any.whl

Download URL frameio_experimental-12.0.1-py3-none-any.whl
Size 485.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
52c6add993c5d60e134e11f6f8f068d875bdb727867aae1763a7e4aed170e01f
BLAKE2b-256 checksum
How to use checksums
48837014319edd55ebd9f357de4b458665b9cce46ecfbfad29490d19bc4e4066
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.22 Linux/7.0.0-1019-azure

Security for frameio-experimental 12.0.1

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.

Release history Release notifications | RSS feed

This release

12.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page