Metadata-Version: 2.3
Name: caido-sdk-client
Version: 0.2.0
Summary: Client SDK for interacting with a Caido instance
Author: Caido Labs Inc.
Author-email: Caido Labs Inc. <dev@caido.io>
Requires-Dist: caido-server-auth>=0.1.2
Requires-Dist: gql[aiohttp,websockets]>=3.5.0
Requires-Dist: pydantic>=2.11.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

  image

  Github (https://github.com/caido-community)
    •  
  Documentation (https://developer.caido.io/)
    •  
  Discord (https://links.caido.io/www-discord)

## 👋 Client SDK

[![PyPI Version](https://img.shields.io/pypi/v/caido-sdk-client?style=for-the-badge)](https://pypi.org/project/caido-sdk-client/)

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](https://github.com/caido-community/sdk-py/tree/main/packages/caido-sdk-client/examples) to learn how to use it.

```python
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](https://links.caido.io/www-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.
