caronte-sdk
Python client for the Argos authorizer — handles app authentication, JWT validation, permission checking and automatic operation sync.
Installation
pip install caronte-sdk
# With FastAPI support
pip install "caronte-sdk[fastapi]"
Quick start with FastAPI
from fastapi import FastAPI, Request
from caronte.adapters.fastapi import Caronte, operation
app = FastAPI()
caronte = Caronte(
app,
authorizer_url="http://localhost:4000/api",
app_id="your-app-uuid",
secret="your-app-secret",
)
@app.get("/public")
@operation(id="public.info", level="public")
async def public_info():
"""Anyone can call this — no token needed."""
return {"message": "Hello, world!"}
@app.get("/items")
@operation(id="items.list", level="private")
async def list_items(request: Request):
"""Requires any authenticated user (token with non-empty groups)."""
user = request.state.user # TokenClaims
return {"user": user.sub, "items": []}
@app.delete("/items/{item_id}")
@operation(id="items.delete", level="protected")
async def delete_item(item_id: str, request: Request):
"""Requires a user whose group has explicit permission for items.delete."""
return {"deleted": item_id}
Standalone client
import asyncio
from caronte import CaronteClient, OperationDescriptor
client = CaronteClient(
authorizer_url="http://localhost:4000/api",
app_id="your-app-uuid",
secret="your-app-secret",
)
client.register_operation(
OperationDescriptor(identifier="items.list", method="read", level="private")
)
async def main():
await client.startup()
# Validate a token from an incoming request
claims = await client.validate_token("<bearer-token>")
# Check whether the token has permission
allowed = client.check_permission(claims, "items.list", "read")
print(f"Allowed: {allowed}")
asyncio.run(main())
Operation levels
| Level | Who can access |
|---|---|
public |
Everyone — no token required |
private |
Any authenticated user (token with at least one group) |
protected |
Only users whose groups intersect the operation's allowed_groups |
Method auto-detection
The @operation decorator infers the method from the function name:
| Function name prefix/keyword | Detected method |
|---|---|
get_, list_, fetch_, read_ |
read |
delete_, remove_, destroy_ |
delete |
contains stream, subscribe, watch |
stream |
| anything else | write |
Configuration
| Parameter | Description |
|---|---|
authorizer_url |
Base URL of Argos, including the API prefix (e.g. http://host/api) |
app_id |
UUID of the app registered in auth.apps |
secret |
Plain-text app secret (never committed — use env vars) |
otel_collector_url |
Optional. OTLP/HTTP endpoint of an OpenTelemetry Collector (e.g. http://localhost:4318). Opt-in — omit it and nothing OTel-related is imported or run. |
import os
from caronte.adapters.fastapi import Caronte
caronte = Caronte(
app,
authorizer_url=os.environ["AUTHORIZER_URL"],
app_id=os.environ["APP_ID"],
secret=os.environ["APP_SECRET"],
)
Observability (OpenTelemetry)
Set otel_collector_url to enable tracing, metrics and logs — auth/JWKS calls
(via httpx) and, when installed, your framework's requests (Django/FastAPI/
Flask) get traced and measured automatically and exported to the Collector;
Python's standard logging output is forwarded too (via a LoggingHandler on
the root logger). Never breaks startup(): a missing [otel] extra or an
unreachable Collector just logs a warning.
pip install "caronte-sdk[otel]"
client = CaronteClient(
authorizer_url=os.environ["AUTHORIZER_URL"],
realm_id=os.environ["REALM_ID"],
app_id=os.environ["APP_ID"],
secret=os.environ["APP_SECRET"],
otel_collector_url=os.environ.get("OTEL_COLLECTOR_URL"), # e.g. http://localhost:4318
)
Every framework adapter (caronte.adapters.django/fastapi/flask/strawberry) accepts the
same otel_collector_url (Django: CARONTE_OTEL_COLLECTOR_URL setting instead, since the
middleware is constructed by Django itself) and forwards it to its internal CaronteClient.
Span attributes
Adapters generally don't create spans themselves — they enrich whichever span
the auto-instrumentation registered by otel_collector_url already created
for the current request (ASGI/httpx/etc). Django is the one exception:
DjangoInstrumentor patches in by inserting itself into settings.MIDDLEWARE
from inside CaronteMiddleware.__init__, but Django builds its middleware
chain by iterating reversed(settings.MIDDLEWARE) — since CaronteMiddleware
must be first in that list, its __init__ runs last in that loop, leaving
no earlier slot for the auto-injection to claim. So CaronteMiddleware.__call__
creates the request's SPAN_KIND_SERVER span manually instead of relying on
that auto-injection.
Each adapter's auth/permission hook adds, best-effort:
| Attribute | Set when | Value |
|---|---|---|
caronte.operation_id |
Always, for any @operation-annotated route/resolver |
the operation's id |
caronte.user |
A token was validated | TokenClaims.sub |
caronte.permission_result |
Always, for any annotated route/resolver | public / unauthorized / forbidden / allowed |
Routes/resolvers with no @operation decorator are left untouched — no caronte.*
attributes are added, since there's no caronte-relevant decision being made.
Strawberry: composing with the official OTel extension
caronte.extension only enforces auth/permissions — it never creates spans
itself. For per-resolver GraphQL tracing, add the official OTel extension
alongside it; that's an app-level choice, not something caronte-sdk forces:
from opentelemetry.instrumentation.strawberry import OpenTelemetryExtensionSync
schema = strawberry.Schema(
query=Query,
extensions=[caronte.extension, OpenTelemetryExtensionSync()],
)
Note: without the second extension, resolve() still enriches whatever span is
currently active (typically the single request-level span from your ASGI framework's
instrumentation) — with multiple resolvers running per request, the last one to run
wins on shared attribute keys. Adding OpenTelemetryExtensionSync() gives each
resolver its own span instead.
Metadata
Release files for caronte-sdk 0.2.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| caronte_sdk-0.2.7.tar.gz | 28.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| caronte_sdk-0.2.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.1 kB
Release files / caronte_sdk-0.2.7.tar.gz
| Download URL | caronte_sdk-0.2.7.tar.gz |
|---|---|
| Size | 28.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
50d7fe6d2aa36de8e9c8e16a7e810301b973d018f94987b86732b202c2290cc5
|
|
BLAKE2b-256 checksum How to use checksums |
caf123fbf539702da6350d0c08c52d06d4a12184875d026ff06fa6a67dfeac46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Release files / caronte_sdk-0.2.7-py3-none-any.whl
| Download URL | caronte_sdk-0.2.7-py3-none-any.whl |
|---|---|
| Size | 26.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f829c46593a9181712f37b36cb7f28c81ed6d20ba54f217f2ae5594dde96ef72
|
|
BLAKE2b-256 checksum How to use checksums |
053ef605078df98360b44831db0bc69e1d779e70cb205887021865657c5cf707
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Security for caronte-sdk 0.2.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.