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 the contract for command implementations.
| Method | arguments |
Set CLI arguments for the command. |
| Method | description |
Set description for the command. |
| Method | get |
Retrieve configured Command entity. |
| Method | timestamp |
Configure timestamp display for command output. |
overridden in
orionis.console.fluent.CommandSet CLI arguments for the command.
Configure accepted command-line arguments.
| Parameters | |
args:list | List of Argument instances. |
| Returns | |
orionis.console.fluent.contracts.command.ICommand | Returns self for method chaining. |
| Raises | |
TypeError | If args is not a list or contains non-Argument elements. |
overridden in
orionis.console.fluent.CommandSet description for the command.
Assign a descriptive text for help and documentation.
| Parameters | |
desc:str | Description text for the command. |
| Returns | |
orionis.console.fluent.contracts.command.ICommand | Returns self for method chaining. |
| Raises | |
TypeError | If desc is not a string. |
overridden in
orionis.console.fluent.CommandRetrieve configured Command entity.
Construct and return CommandEntity with all configuration.
| Returns | |
tuple of (str, orionis.console.entities.Command) | Command signature and CommandEntity instance. |
overridden in
orionis.console.fluent.CommandConfigure timestamp display for command output.
Enable or disable timestamps in command results.
| Parameters | |
enabled:bool, default True | Enable or disable timestamp display. |
| Returns | |
orionis.console.fluent.contracts.command.ICommand | Returns self for method chaining. |
| Raises | |
TypeError | If enabled is not a boolean. |