Metadata-Version: 2.4
Name: aurora_origin_sdk
Version: 0.30.0
Author-email: Aurora Development <aurora_development@auroraer.com>
License: MIT License
        
        Copyright (c) 2023 Aurora Energy Research
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/AuroraEnergyResearch/aurora-origin-python-sdk
Keywords: aurora,energy,research,auroraenergyresearch,aer,origin,sdk
Requires-Python: <3.15,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3.0,>=2.28.2
Requires-Dist: appdirs<2.0,>=1.4.4
Requires-Dist: pandas>=2.3.3; python_version >= "3.14"
Requires-Dist: pandas; python_version < "3.14"
Provides-Extra: setup
Requires-Dist: pytest-runner; extra == "setup"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Provides-Extra: development
Requires-Dist: mypy; extra == "development"
Requires-Dist: flake8; extra == "development"
Requires-Dist: black; extra == "development"
Requires-Dist: pytest; extra == "development"
Requires-Dist: pytest-snapshot; extra == "development"
Requires-Dist: debugpy; extra == "development"
Requires-Dist: novella; extra == "development"
Requires-Dist: pydoc-markdown[novella]; extra == "development"
Provides-Extra: notebooks
Requires-Dist: matplotlib; extra == "notebooks"
Requires-Dist: pandas; extra == "notebooks"
Requires-Dist: ipykernel; extra == "notebooks"
Dynamic: license-file

# 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

```bash
# 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
```

2. 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`.

3. Import `OriginSession` and initialise.

```python
from origin_sdk.OriginSession import OriginSession
session  = OriginSession()
result  = session.get_projects()
print(res[0])
```

4. See
   [the documentation](https://auroraenergyresearch.github.io/aurora-origin-python-sdk)
   for further details on the SDK.
