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

Undocumented

Method done Log the completion of a program in the "DONE" state.
Method fail Log program execution in the "FAIL" state.
Method running Log the execution of a program in the "RUNNING" state.
def done(self, program: str, time: str = ''): (source)

Log the completion of a program in the "DONE" state.

Outputs a formatted console message indicating successful completion of a program or process. Uses ANSI color coding to highlight the completion state with a success color. The output includes timestamp, program name, optional execution time, and colored state indicator.

Parameters
program:strName of the program or process that has completed execution.
time:str, optionalTotal execution time duration with units. Default is ''.
Returns
NoneThis method prints the formatted completion state message to the console.
def fail(self, program: str, time: str = ''): (source)

Log program execution in the "FAIL" state.

Outputs a formatted console message indicating that a program or process has failed. Uses ANSI color coding to highlight the failure state with an error color. The output includes timestamp, program name, optional execution time, and colored state indicator.

Parameters
program:strName of the program or process that failed.
time:str, optionalExecution time duration before failure. Default is ''.
Returns
NoneThis method prints the formatted failure state message to the console.
def running(self, program: str, time: str = ''): (source)

Log the execution of a program in the "RUNNING" state.

Outputs a formatted console message indicating that a program or process is currently running. Uses ANSI color coding to highlight the running state with a warning color. The output includes timestamp, program name, optional execution time, and colored state indicator.

Parameters
program:strName of the program or process being executed.
time:str, optionalCurrent execution time duration with units. Default is ''.
Returns
NoneThis method prints the formatted running state message to the console.