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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caido_sdk_client-0.3.0.tar.gz (78.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

caido_sdk_client-0.3.0-py3-none-any.whl (130.8 kB view details)

Uploaded Python 3

File details

Details for the file caido_sdk_client-0.3.0.tar.gz.

File metadata

  • Download URL: caido_sdk_client-0.3.0.tar.gz
  • Upload date:
  • Size: 78.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.8

File hashes

Hashes for caido_sdk_client-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f7f7754ca9382a15da1fe4e7d57244e6828be100555008f6374510c12f79e6db
MD5 ed42ac2f188be70095ca5a4604a1345d
BLAKE2b-256 34dc046ab80eddf34e4b0015737d027ae2d9c4985c4161947cc4391d5fb4b363

See more details on using hashes here.

File details

Details for the file caido_sdk_client-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for caido_sdk_client-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9700234a6adb7920d5269ee6e8f47ace44fa86c0d9fc0f483b47708971cc2adc
MD5 0b69de754f26791ac13cee0d0ce70d54
BLAKE2b-256 3f7d1b9d4f5690aa19c61efb044fe75a70fd9f807cf2c71cd0f8009972d7abc8

See more details on using hashes here.

Supported by

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