From e453509b2cf7a478cd99f9d71b4eae67e7513eb9 Mon Sep 17 00:00:00 2001 From: Beon de Nood Date: Tue, 17 Feb 2026 00:12:55 +0200 Subject: [PATCH] docs(sdk-python): Add connect() and SecurityConfig.from_env() documentation - Add CapiscIO.connect() card to SDK reference index - Add from_env() section to config docs with env var table - Document CAPISCIO_REQUIRE_SIGNATURES, CAPISCIO_FAIL_MODE, CAPISCIO_MIN_TRUST_LEVEL --- docs/reference/sdk-python/config.md | 23 +++++++++++++++++++++++ docs/reference/sdk-python/index.md | 9 +++++++++ 2 files changed, 32 insertions(+) diff --git a/docs/reference/sdk-python/config.md b/docs/reference/sdk-python/config.md index dd58395..9467ce4 100644 --- a/docs/reference/sdk-python/config.md +++ b/docs/reference/sdk-python/config.md @@ -57,6 +57,29 @@ Maximum security: - Verbose logging - No fallbacks +### From Environment Variables + +```python +config = SecurityConfig.from_env() +``` + +Reads configuration from environment variables: + +| Variable | Description | Default | +|----------|-------------|--------| +| `CAPISCIO_REQUIRE_SIGNATURES` | Require badge on requests | `true` | +| `CAPISCIO_FAIL_MODE` | `block`, `monitor`, or `log` | `block` | +| `CAPISCIO_MIN_TRUST_LEVEL` | Minimum trust level (0-4) | `0` | +| `CAPISCIO_RATE_LIMIT_RPM` | Rate limit (requests/min) | `1000` | + +**Example `.env` file:** + +```bash +CAPISCIO_REQUIRE_SIGNATURES=true +CAPISCIO_FAIL_MODE=block +CAPISCIO_MIN_TRUST_LEVEL=0 +``` + --- ## API Reference diff --git a/docs/reference/sdk-python/index.md b/docs/reference/sdk-python/index.md index 8ac8593..555658c 100644 --- a/docs/reference/sdk-python/index.md +++ b/docs/reference/sdk-python/index.md @@ -79,6 +79,15 @@ from capiscio_sdk._rpc.client import CapiscioRPCClient [:octicons-arrow-right-24: Badge API](badge.md) +- :material-key: **CapiscIO.connect()** + + --- + + "Let's Encrypt" style agent setup. One-liner to get a fully + configured agent with DID, keys, and badges. + + [:octicons-arrow-right-24: Connect API](#capiscioconnect) + - :material-shield-check: **SimpleGuard** ---