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.

Metadata

Release files for caido-sdk-client 0.3.2

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.2
File Size Uploaded
caido_sdk_client-0.3.2.tar.gz 79.9 kB Details

Built distribution (wheel)

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

Total release size: 211.0 kB

Release files / caido_sdk_client-0.3.2.tar.gz

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

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

Download URL caido_sdk_client-0.3.2-py3-none-any.whl
Size 131.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88e07549ef36bd5fc0d57af17c1e4f1ac659bfed63dd24749239582cc1f1c915
BLAKE2b-256 checksum
How to use checksums
43f58a4a1dc8177d514e562a781ec76d7c6a1aae05a66d97284acd7a893461aa
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.2 This release

2 release files

0.3.1

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