ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class Configuration(BaseEntity): (source)

View In Hierarchy

Represent the main configuration for Orionis Framework startup.

Parameters
appApplication configuration settings.
authAuthentication configuration settings.
cacheCache configuration settings.
databaseDatabase configuration settings.
filesystemsFilesystem configuration settings.
loggingLogging configuration settings.
mailMail configuration settings.
hashingPassword hashing configuration settings.
schedulerScheduled task configuration settings.
viewTemplate rendering configuration settings.
httpHTTP configuration settings.
queueQueue configuration settings.
realtimeRealtime invocation, message and broadcast limits.
sessionSession configuration settings.
testingTesting configuration settings.
mcpMCP protocol limits and trusted browser origins.
Returns
NoneThis class does not return a value upon instantiation.
Raises
TypeErrorIf any configuration section is initialized with an invalid type.
Method __post_init__ Validate and convert configuration attributes to their entity types.
Class Variable app Undocumented
Class Variable auth Undocumented
Class Variable cache Undocumented
Class Variable database Undocumented
Class Variable filesystems Undocumented
Class Variable hashing Undocumented
Class Variable http Undocumented
Class Variable logging Undocumented
Class Variable mail Undocumented
Class Variable mcp Undocumented
Class Variable queue Undocumented
Class Variable realtime Undocumented
Class Variable scheduler Undocumented
Class Variable session Undocumented
Class Variable testing Undocumented
Class Variable view Undocumented

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method getFields Describe field names, normalized types, defaults, and metadata.
Method toDict Convert the dataclass instance to a recursively copied dictionary.
Class Variable __slots__ Undocumented
def __post_init__(self): (source)

Validate and convert configuration attributes to their entity types.

Returns
NoneThis method does not return a value.
app: App | dict, optional = (source)

Undocumented

auth: Auth | dict, optional = (source)

Undocumented

cache: Cache | dict, optional = (source)

Undocumented

database: Database | dict, optional = (source)

Undocumented

filesystems: Filesystems | dict, optional = (source)

Undocumented

hashing: Hashing | dict, optional = (source)

Undocumented

http: HTTP | dict, optional = (source)

Undocumented

logging: Logging | dict, optional = (source)

Undocumented

mail: Mail | dict, optional = (source)

Undocumented

mcp: McpConfig | dict, optional = (source)

Undocumented

queue: Queue | dict, optional = (source)

Undocumented

realtime: RealtimeConfig | dict, optional = (source)

Undocumented

scheduler: Scheduler | dict, optional = (source)

Undocumented

session: Session | dict, optional = (source)

Undocumented

testing: Testing | dict, optional = (source)

Undocumented

view: View | dict, optional = (source)

Undocumented