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 auth concerns components and public imports.

Module authenticatable Turn any Orionis model into an authenticatable identity.
Module authorizable Let any Orionis model own permissions and roles.
Module functions Provide auth concerns operations.
Module must_verify_email Require identities to verify their email address before activation.

From __init__.py:

Class Authenticatable Turn any Orionis model into an authenticatable identity.
Class Authorizable Let any Orionis model own permissions and roles.
Class MustVerifyEmail Require identities to verify their email address before activation.
Function model_primary_key Return the primary key attribute of a model instance.
def model_primary_key(instance: object) -> str: (source)

Return the primary key attribute of a model instance.

The lookup is duck typed on purpose: the authentication module must never import the ORM model class, so it only reads the metadata the ORM metaclass already publishes.

Parameters
instance:objectObject expected to expose __meta__.primary_key.
Returns
strName of the primary key attribute, falling back to "id" for objects without ORM metadata.