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

Define access to the application directory paths.

Method app Return the application directory.
Method appConsole Return the application console directory.
Method appConsoleCommands Return the application console commands directory.
Method appConsoleListeners Return the application console listeners directory.
Method appContracts Return the application contracts directory.
Method appExceptions Return the application exceptions directory.
Method appFacades Return the application facades directory.
Method appHttp Return the application HTTP directory.
Method appHttpControllers Return the application controllers directory.
Method appHttpMiddleware Return the application HTTP middleware directory.
Method appHttpSchemas Return the application HTTP schemas directory.
Method appHttpSchemasRules Return the application HTTP schema rules directory.
Method appJobs Return the application jobs directory.
Method appMcp Return the MCP application directory.
Method appMcpPrompts Return the MCP prompt declarations directory.
Method appMcpResources Return the MCP resource declarations directory.
Method appMcpServers Return the MCP server declarations directory.
Method appMcpTools Return the MCP tool declarations directory.
Method appModels Return the application models directory.
Method appNotifications Return the application notifications directory.
Method appProviders Return the application providers directory.
Method appServices Return the application services directory.
Method bootstrap Return the bootstrap directory.
Method config Return the configuration directory.
Method database Return the database directory.
Method databaseFactories Return the database factories directory.
Method databaseMigrations Return the database migrations directory.
Method databaseSchemas Return the database schemas directory.
Method databaseSeeders Return the database seeders directory.
Method resources Return the resources directory.
Method resourcesCss Return the resources CSS directory.
Method resourcesJs Return the resources JavaScript directory.
Method resourcesLang Return the resources language directory.
Method resourcesViews Return the resources views directory.
Method root Return the application root directory.
Method routes Return the routes directory.
Method storage Return the storage directory.
Method storageApp Return the storage application directory.
Method storageAppPrivate Return the private storage application directory.
Method storageAppPublic Return the public storage application directory.
Method storageFramework Return the framework storage directory.
Method storageLogs Return the storage logs directory.
Method tests Return the tests directory.
Class Variable __slots__ Undocumented

Return the application directory.

Returns
PathThe configured application directory.
def appConsole(self) -> Path: (source)

Return the application console directory.

Returns
PathThe configured application console directory.
def appConsoleCommands(self) -> Path: (source)

Return the application console commands directory.

Returns
PathThe configured application console commands directory.
def appConsoleListeners(self) -> Path: (source)

Return the application console listeners directory.

Returns
PathThe configured application console listeners directory.
def appContracts(self) -> Path: (source)

Return the application contracts directory.

Returns
PathThe configured application contracts directory.
def appExceptions(self) -> Path: (source)

Return the application exceptions directory.

Returns
PathThe configured application exceptions directory.
def appFacades(self) -> Path: (source)

Return the application facades directory.

Returns
PathThe configured application facades directory.
def appHttp(self) -> Path: (source)

Return the application HTTP directory.

Returns
PathThe configured application HTTP directory.
def appHttpControllers(self) -> Path: (source)

Return the application controllers directory.

Returns
PathThe configured application controllers directory.
def appHttpMiddleware(self) -> Path: (source)

Return the application HTTP middleware directory.

Returns
PathThe configured application HTTP middleware directory.
def appHttpSchemas(self) -> Path: (source)

Return the application HTTP schemas directory.

Returns
PathThe configured application HTTP schemas directory.
def appHttpSchemasRules(self) -> Path: (source)

Return the application HTTP schema rules directory.

Returns
PathThe configured application HTTP schema rules directory.
def appJobs(self) -> Path: (source)

Return the application jobs directory.

Returns
PathThe configured application jobs directory.
def appMcp(self) -> Path: (source)

Return the MCP application directory.

Returns
PathThe configured application directory.
def appMcpPrompts(self) -> Path: (source)

Return the MCP prompt declarations directory.

Returns
PathThe configured application directory.
def appMcpResources(self) -> Path: (source)

Return the MCP resource declarations directory.

Returns
PathThe configured application directory.
def appMcpServers(self) -> Path: (source)

Return the MCP server declarations directory.

Returns
PathThe configured application directory.
def appMcpTools(self) -> Path: (source)

Return the MCP tool declarations directory.

Returns
PathThe configured application directory.
def appModels(self) -> Path: (source)

Return the application models directory.

Returns
PathThe configured application models directory.
def appNotifications(self) -> Path: (source)

Return the application notifications directory.

Returns
PathThe configured application notifications directory.
def appProviders(self) -> Path: (source)

Return the application providers directory.

Returns
PathThe configured application providers directory.
def appServices(self) -> Path: (source)

Return the application services directory.

Returns
PathThe configured application services directory.
def bootstrap(self) -> Path: (source)

Return the bootstrap directory.

Returns
PathThe configured bootstrap directory.
def config(self) -> Path: (source)

Return the configuration directory.

Returns
PathThe configured configuration directory.
def database(self) -> Path: (source)

Return the database directory.

Returns
PathThe configured database directory.
def databaseFactories(self) -> Path: (source)

Return the database factories directory.

Returns
PathThe configured database factories directory.
def databaseMigrations(self) -> Path: (source)

Return the database migrations directory.

Returns
PathThe configured database migrations directory.
def databaseSchemas(self) -> Path: (source)

Return the database schemas directory.

Returns
PathThe configured database schemas directory.
def databaseSeeders(self) -> Path: (source)

Return the database seeders directory.

Returns
PathThe configured database seeders directory.
def resources(self) -> Path: (source)

Return the resources directory.

Returns
PathThe configured resources directory.
def resourcesCss(self) -> Path: (source)

Return the resources CSS directory.

Returns
PathThe configured resources CSS directory.
def resourcesJs(self) -> Path: (source)

Return the resources JavaScript directory.

Returns
PathThe configured resources JavaScript directory.
def resourcesLang(self) -> Path: (source)

Return the resources language directory.

Returns
PathThe configured resources language directory.
def resourcesViews(self) -> Path: (source)

Return the resources views directory.

Returns
PathThe configured resources views directory.
def root(self) -> Path: (source)

Return the application root directory.

Returns
PathThe configured application root directory.
def routes(self) -> Path: (source)

Return the routes directory.

Returns
PathThe configured routes directory.
def storage(self) -> Path: (source)

Return the storage directory.

Returns
PathThe configured storage directory.
def storageApp(self) -> Path: (source)

Return the storage application directory.

Returns
PathThe configured storage application directory.
def storageAppPrivate(self) -> Path: (source)

Return the private storage application directory.

Returns
PathThe configured private storage application directory.
def storageAppPublic(self) -> Path: (source)

Return the public storage application directory.

Returns
PathThe configured public storage application directory.
def storageFramework(self) -> Path: (source)

Return the framework storage directory.

Returns
PathThe configured framework storage directory.
def storageLogs(self) -> Path: (source)

Return the storage logs directory.

Returns
PathThe configured storage logs directory.
def tests(self) -> Path: (source)

Return the tests directory.

Returns
PathThe configured tests directory.