oedialect 0.1.1

SQL-Alchemy dialect for the OpenEnergy Platform

An SQLAlchemy Dialect for the OEP

SQLAlchemy internally uses so called "dialects" to provide a consistent interface to different database drivers. The oedialect supplies your SQLAlchemy installation with a dialect using the REST-API of the Open Energy Platform (OEP). In short, the oedialect allows you to use SQLAlchemy to down- and upload data to an OEP instance.

License / Copyright

This repository is licensed under GNU Affero General Public License v3.0 (AGPL-3.0)

Installation

pip install oedialect

On MS-Windows make sure to install a version of shapely first. conda install shapely -c conda-forge

Tutorials

You can find tutorials and examples here.

Testing

To run the tests locally, first install the tox test environment pip install tox

You need to setup a local instance of the Open Energy Platform

Set your connection token that you got from your local OEP instance LOCAL_OEP_TOKEN=<your_token>

Finally, run tox