Skip to main content

Client SDK for interacting with a Caido instance

Project description

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.

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

caido_sdk_client-0.2.0.tar.gz (57.4 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.2.0-py3-none-any.whl (96.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for caido_sdk_client-0.2.0.tar.gz
Algorithm Hash digest
SHA256 39988fe07b3fa9c69adbd49662db660d7707d60d9245109b1623def97b39bac8
MD5 f45328a9b98ffebda7ea0b323e23a029
BLAKE2b-256 62d75381d8d94fec799bec7004decbf33a4c5581a8374941fe784e730e01cf80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for caido_sdk_client-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc573651681c093ee9663c7924d38d522a89cea60e2ce00d34ba9b02942b1da1
MD5 40aade68ba7d862c60efd1dd89a4489c
BLAKE2b-256 30ae3530caa6a79bafb8049374ca09515686d98532aca73c4fdbd0f6e06de5c9

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