Skip to content

docs(sdk-python): Add connect() and SecurityConfig.from_env() documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
beonde wants to merge 1 commit into from
Closed

docs(sdk-python): Add connect() and SecurityConfig.from_env() documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/reference/sdk-python/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment on lines +70 to +80
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This environment variable table conflicts with the existing SecurityConfig.from_env() documentation in docs/reference/configuration.md (e.g., CAPISCIO_REQUIRE_SIGNATURES default is documented as false there, and CAPISCIO_RATE_LIMIT_RPM default as 60, not true/1000). Also, the description "Require badge on requests" appears mismatched for CAPISCIO_REQUIRE_SIGNATURES (it maps to signature enforcement in the other doc). Please align the defaults/wording with the canonical configuration reference (or update both consistently) to avoid publishing contradictory docs.

Suggested change
| `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
| `CAPISCIO_REQUIRE_SIGNATURES` | Require signatures on requests | `false` |
| `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) | `60` |
**Example `.env` file:**
```bash
CAPISCIO_REQUIRE_SIGNATURES=false
CAPISCIO_FAIL_MODE=block
CAPISCIO_MIN_TRUST_LEVEL=0
CAPISCIO_RATE_LIMIT_RPM=60

Copilot uses AI. Check for mistakes.
```

---

## API Reference
Expand Down
9 changes: 9 additions & 0 deletions docs/reference/sdk-python/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Comment on lines +82 to +90
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Connect API" link points to the in-page anchor #capiscioconnect, but this page doesn't define that anchor (no capiscioconnect heading/id elsewhere). This will render as a broken link; either add a corresponding section (e.g., a heading/mkdocstrings block for CapiscIO.connect) or link to an existing page that documents CapiscIO.connect() (and ensure the target exists).

Copilot uses AI. Check for mistakes.
- :material-shield-check: **SimpleGuard**

---
Expand Down