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 realtime components and public imports.
| Module | clients |
Provide realtime operations. |
| Module | config |
Define config for realtime. |
| Module | connection |
Own tasks and pending client results for exactly one connection. |
| Package | contracts |
Group the realtime contracts components and public imports. |
| Module | decorators |
Provide realtime operations. |
| Module | entities |
Count delivered and failed recipients without retaining connections. |
| Module | errors |
Provide realtime operations. |
| Module | groups |
Manage group membership owned by the current Hub connection. |
| Module | hub |
Provide realtime operations through HubContext, Hub. |
| Module | manager |
Own worker-local connections and isolate every group by Hub class. |
| Module | metadata |
Describe one pre-authorized method without retaining a Hub instance. |
| Module | protocol |
Provide realtime operations. |
| Module | provider |
Register one worker-local registry and pin the synchronous target facade. |
| Module | runtime |
Execute a precompiled Hub using the existing application and scopes. |
From __init__.py:
| Class | |
Count delivered and failed recipients without retaining connections. |
| Class | |
Own worker-local connections and isolate every group by Hub class. |
| Class | |
Define an invocation-scoped realtime endpoint with explicit remote methods. |
| Class | |
Select ready clients within one Hub in the current worker. |
| Class | |
Expose connection identity without providing service location. |
| Class | |
Manage group membership owned by the current Hub connection. |
| Class | |
Encode Orionis Realtime v1 using route-selected JSON or MessagePack. |
| Function | __dir__ |
List declared exports and loaded package attributes. |
| Function | __getattr__ |
Resolve and cache a declared realtime export. |
| Function | remote |
Mark an instance method for remote dispatch without wrapping it. |
| Constant | _EXPORTS |
Public export names mapped to their defining modules and attributes. |
Resolve and cache a declared realtime export.
| Parameters | |
name:str | Public package attribute requested by application code. |
| Returns | |
object | Declared realtime class or decorator. |
| Raises | |
AttributeError | If the name is not exported. |
Mark an instance method for remote dispatch without wrapping it.
| Parameters | |
function:F | None, optional | Method supplied by bare decorator syntax. |
name:str | None, optional | Explicit public alias, otherwise the Python method name. |
| Returns | |
F | collections.abc.Callable[[F], F] | Original function, or a decorator returning the original function. |
| Raises | |
TypeError | If the decorated object is not a Python function. |
ValueError | If the method name or alias is invalid, or the method is already marked. |
Public export names mapped to their defining modules and attributes.
| Value |
|