Skip to main content

SDK for Airtop cloud browsers

Project description

Airtop Python Library

fern shield pypi

The Airtop Python library provides convenient access to the Airtop API from Python.

Installation

pip install airtop

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from airtop import Airtop

client = Airtop(
    api_key="YOUR_API_KEY",
)
client.windows.create(
    session_id="6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from airtop import AsyncAirtop

client = AsyncAirtop(
    api_key="YOUR_API_KEY",
)


async def main() -> None:
    await client.windows.create(
        session_id="6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
    )


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 airtop.core.api_error import ApiError

try:
    client.windows.create(...)
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 airtop import Airtop

client = Airtop(
    api_key="YOUR_API_KEY",
)
response = client.sessions.events(
    id="string",
)
for chunk in response:
    yield chunk

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.windows.create(..., 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 airtop import Airtop

client = Airtop(
    ...,
    timeout=20.0,
)


# Override timeout for a specific method
client.windows.create(..., 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 airtop import Airtop

client = Airtop(
    ...,
    httpx_client=httpx.Client(
        proxies="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!

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

airtop-0.0.36.tar.gz (50.5 kB view details)

Uploaded Source

Built Distribution

airtop-0.0.36-py3-none-any.whl (93.7 kB view details)

Uploaded Python 3

File details

Details for the file airtop-0.0.36.tar.gz.

File metadata

  • Download URL: airtop-0.0.36.tar.gz
  • Upload date:
  • Size: 50.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1078-azure

File hashes

Hashes for airtop-0.0.36.tar.gz
Algorithm Hash digest
SHA256 36df1af6e35d8caced075d5f287e2e5fb97ba38e613bf99e665d00f3bae78b18
MD5 c269313437db3ad9c115bc43c9e159f8
BLAKE2b-256 ed32a1e5ba1f57ffb4cb54d0f08915c8eee3562927cc358edb3b40327d65e2fc

See more details on using hashes here.

File details

Details for the file airtop-0.0.36-py3-none-any.whl.

File metadata

  • Download URL: airtop-0.0.36-py3-none-any.whl
  • Upload date:
  • Size: 93.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1078-azure

File hashes

Hashes for airtop-0.0.36-py3-none-any.whl
Algorithm Hash digest
SHA256 8daea27abef83d1b61fc59e2d74e80ea9a4039671790f07c0ad7d7703677dd61
MD5 5e3b43aff5c3e93312d0aba7aa81263b
BLAKE2b-256 7f456c6a2f339a91843fc1fe8668dce8d9f4d226be9b00705cba3ad953af6cf6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page