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

Package entities Group the foundation config auth entities components and public imports.
Package enums Group the foundation config auth enums components and public imports.

From __init__.py:

Class Auth Represent the authentication and authorization configuration.
Class Identity Represent how the application identity is located and verified.
Class PasswordReset Represent the configuration of password reset functionality.
Class RememberAuth Configure the optional persistent login cookie separately from sessions.
Class SessionAuth Represent the configuration of session based authentication.
Class Tokens Represent the configuration of personal access token authentication.
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
{'Auth': ('orionis.foundation.config.auth.entities.auth', 'Auth'),
 'Guards': ('orionis.foundation.config.auth.enums.guards', 'Guards'),
 'Identity': ('orionis.foundation.config.auth.entities.identity', 'Identity'),
 'PasswordReset': ('orionis.foundation.config.auth.entities.password_reset',
                   'PasswordReset'),
 'RememberAuth': ('orionis.foundation.config.auth.entities.remember',
                  'RememberAuth'),
...