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.

package documentation

Group the console components and public imports.

Package args Group the console args components and public imports.
Package base Group the console base components and public imports.
Module bootstrap Provide console operations.
Module cli Provide console operations through main.
Package commands Group the console commands components and public imports.
Package contracts Group the console contracts components and public imports.
Package core Group the console core components and public imports.
Package debug Group the console debug components and public imports.
Package dynamic Group the console dynamic components and public imports.
Package entities Group the console entities components and public imports.
Package enums Group the console enums components and public imports.
Package fluent Group the console fluent components and public imports.
Module kernel Bootstrap the console runtime and dispatch command invocations.
Package output Group the console output components and public imports.
Module reactor_provider Register reactor services in the application container.
Module scheduler_provider Register schedule services in the application container.
Module startup Provide startup feedback for console commands.
Module stdio Provide console operations through protocol_stdout, protocol_stdio.
Package tasks Group the console tasks components and public imports.
Package templates Group the console templates components and public imports.

From __init__.py:

Class Argument Represent a command-line argument definition.
Class Console Provide formatted console output, prompts and interactive utilities.
Class Dumper Implement synchronous dumping independently of application boot.
Class ProgressBar Manage console progress tasks and their displayed state.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'Argument': ('orionis.console.args.argument', 'Argument'),
 'Console': ('orionis.console.output.console', 'Console'),
 'Dumper': ('orionis.console.debug.dumper', 'Dumper'),
 'ProgressBar': ('orionis.console.dynamic.progress_bar', 'ProgressBar')}