Metadata-Version: 2.3
Name: caido-server-auth
Version: 0.1.1
Summary: Authenticate with a Caido instance.
Author: Caido Labs Inc.
Author-email: Caido Labs Inc. <dev@caido.io>
Requires-Dist: gql[aiohttp,websockets]>=3.5.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)

## 👋 Server Auth

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

Authenticate with a Caido instance using device code flow.

```python
import asyncio
import os

from caido_server_auth import (
    AuthClient,
    AuthClientOptions,
    AuthenticationRequest,
    BrowserApprover,
)


def on_request(request: AuthenticationRequest) -> None:
    print(f"Visit: {request.verification_url}")
    print(f"Expires at: {request.expires_at.isoformat()}")


async def main() -> None:
    instance_url = os.environ.get("CAIDO_INSTANCE_URL", "http://localhost:8080")
    auth = AuthClient(
        AuthClientOptions(
            instance_url=instance_url,
            approver=BrowserApprover(on_request),
        )
    )
    token = await auth.start_authentication_flow()
    print(token.access_token)


asyncio.run(main())
```

## Examples

See the `examples` directory for complete working examples:

- `examples/browser_auth.py` - Manual approval via browser
- `examples/pat_auth.py` - Automated approval using Personal Access Token

## 💚 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.
