EmpyrealSDK#

class empyrealSDK.EmpyrealSDK(api_key: str, env: Literal['local', 'prod'] = 'prod')[source]#

Bases: object

The EmpyrealSDK instance. This is currently a global, singleton instance. So when a user initializes the empyrealSDK instance, this will be used automatically in all Empyreal types.

Examples

Initially in any codebase using the SDK, be sure to declare

>>> from empyrealSDK import *
>>> api_key = "<api_key>"
>>> EmpyrealSDK(api_key)
>>> app = Application.load()

This will declare your SDK instance and inject it in all method invocations. Then when you call 5 empyrealSDK.types.Application.load(), you are able to get the instance attached to your API_KEY.