Skip to content

AuroraEnergyResearch/aurora-origin-python-sdk

Repository files navigation

Aurora Origin SDK

Python SDK for accessing data from Origin, Aurora's Market model platform.

Installation

Note

We support running the SDK in all currently supported versions of Python: 3.10 - 3.14.

Warning

Python 3.9 support is deprecated and will be removed in a future release. Please upgrade to Python 3.10 or later.

  1. Install the package from the git repository
# Use pip:
pip install git+https://github.com/AuroraEnergyResearch/aurora-origin-python-sdk
# Or uv:
uv add git+https://github.com/AuroraEnergyResearch/aurora-origin-python-sdk
  1. Add your Aurora API key to the file $home/.aurora-api-key. for example C:\Users\Joe Bloggs\.aurora-api-key or set as the environment variable AURORA_API_KEY.

  2. Import OriginSession and initialise.

from origin_sdk.OriginSession import OriginSession
session  = OriginSession()
result  = session.get_projects()
print(res[0])
  1. See the documentation for further details on the SDK.

About

Python SDK for accessing data from Origin, Aurora's Market model platform.

Topics

Resources

License

Stars

Watchers

Forks

Contributors