Skip to content

API Reference

xcoreSDK exposes 49 public symbols from a single import path: xcore.sdk.

1
from xcore.sdk import AutoMixin, action, ok, cached, traced, on_event, ...

By category

Category Key exports
AutoMixin AutoMixin
Decorators action, route, schema, validate_payload, require_service, trusted, sandboxed
DB Adapters BaseAsyncRepository, BaseSyncRepository, BaseMongoRepository, BaseRedisRepository
Events & Hooks on_event, on_hook, EventMixin, HookMixin, Event, HookResult
Observability traced, counted, timed, health_check, ObservabilityMixin, get_logger
Scheduler cron, interval, ScheduledMixin
Cache cached, invalidate
Auth AuthBackend, AuthPayload, register_auth_backend, get_auth_backend
Manifest PluginManifest, ResourceConfig, RuntimeConfig
Responses ok, error

Full export list

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Base classes
AutoMixin
TrustedBase
BasePlugin
ExecutionMode
PluginState

# Dispatch & routing
AutoDispatchMixin
RoutedPlugin
RouterRegistry
action
route

# Payload & access
schema
validate_payload
require_service
trusted
sandboxed

# Events & hooks
EventMixin
HookMixin
Event
HookResult
on_event
on_hook

# Observability
ObservabilityMixin
get_logger
traced
counted
timed
health_check

# Scheduler
ScheduledMixin
cron
interval

# Cache
cached
invalidate

# DB adapters
BaseAsyncRepository
BaseSyncRepository
BaseMongoRepository
BaseRedisRepository

# Auth
AuthBackend
AuthPayload
register_auth_backend
unregister_auth_backend
get_auth_backend
has_auth_backend

# RBAC
RBACChecker
require_permission
require_role
PermissionDenied

# Manifest types
PluginManifest
ResourceConfig
RuntimeConfig

# Responses
ok
error