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

Package contracts Group the environment contracts components and public imports.
Package core Group the environment core components and public imports.
Package dynamic Group the environment dynamic components and public imports.
Package enums Group the environment enums components and public imports.
Module facade Read typed environment values through the environment service facade.
Module functions Provide environment operations through env.
Package key Group the environment key components and public imports.
Package validators Group the environment validators components and public imports.

From __init__.py:

Class Env Read typed environment values through the environment service facade.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Function env Retrieve the value of an environment variable using the Env facade.
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.
def env(key: str, default: object | None = None) -> object: (source)

Retrieve the value of an environment variable using the Env facade.

Parameters
key:strThe name of the environment variable to retrieve.
default:object | None, optionalThe value to return if the environment variable is not found. Defaults to None.
Returns
objectThe value of the environment variable if it exists, otherwise the specified default value.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'Env': ('orionis.environment.facade', 'Env'),
 'env': ('orionis.environment.functions', 'env')}