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.

module documentation

Provide console commands bootstrap operations.

Includes application_path, display_path.

Function application_path Resolve an effective application path with the framework default.
Function display_path Format a path relative to the application when possible.
def application_path(app: IApplication, key: str) -> Path: (source)

Resolve an effective application path with the framework default.

Parameters
app:orionis.IApplicationConfigured application owning the path registry.
key:strCentralized application path key.
Returns
pathlib.PathAbsolute destination honoring the effective application configuration.
Raises
TypeErrorIf a configured path is not a filesystem path.
def display_path(app: IApplication, path: Path) -> str: (source)

Format a path relative to the application when possible.

Parameters
app:orionis.IApplicationApplication providing the project root.
path:pathlib.PathResource to display.
Returns
strPortable project-relative path or an absolute external path.