Skip to main content
image

Github   •   Documentation   •   Discord

👋 Client SDK

PyPI Version

This is the Caido client SDK for Python.

The goal of this SDK is to allow scripts to access Caido instances. It handles authentication, GraphQL and REST.

We recommend you look at the examples to learn how to use it.

import asyncio
from caido_sdk_client import AuthCacheFile, Client, PATAuthOptions

async def main():
    client = Client(
        "http://localhost:8080",
        auth=PATAuthOptions(
            pat="caido_xxxxxx",
            cache=AuthCacheFile(file=".secrets.json"),
        ),
    )

    await client.connect()

    viewer = await client.user.viewer()
    print("Viewer:", json.dumps(dataclasses.asdict(viewer), indent=2))

asyncio.run(main())

💚 Community

Come join our Discord community and connect with other Caido users! We'd love to have you as part of the conversation and help with any questions you may have.

Release files for caido-sdk-client 0.3.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 caido-sdk-client 0.3.1
File Size Uploaded
caido_sdk_client-0.3.1.tar.gz 79.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for caido-sdk-client 0.3.1
File Interpreter ABI Platform
caido_sdk_client-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 211.0 kB

Release files / caido_sdk_client-0.3.1.tar.gz

Download URL caido_sdk_client-0.3.1.tar.gz
Size 79.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f63bdde3d41e3e16e8c6d1c30f259cba696234b5fc9f66df3a336371958b283b
BLAKE2b-256 checksum
How to use checksums
fed19e2165528347370e42b94d8568c6a083e485c3e1176b29d9ab1a5498f0b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.9.8

Release files / caido_sdk_client-0.3.1-py3-none-any.whl

Download URL caido_sdk_client-0.3.1-py3-none-any.whl
Size 131.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
16af5cfd19fef9bd676e2705551331247fd107a68505a69c8ba78aaa09c14dd2
BLAKE2b-256 checksum
How to use checksums
882dfd45f5464abe005ac6688ee49b4e54eabe4c59343608a542c72f3ef194db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.9.8

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

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