<a href="http://oep.iks.cs.ovgu.de/"><img align="right" width="200" height="200" src="https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4" alt="OpenEnergyPlatform"></a>
# An [SQLAlchemy][0] [Dialect][1] for the [OEP][2]
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)][2]. In short, the `oedialect` allows you to use
SQLAlchemy to down- and upload data to an OEP instance.
[0]: https://www.sqlalchemy.org/
[1]: https://docs.sqlalchemy.org/en/13/dialects/
[2]: https://github.com/OpenEnergyPlatform/oeplatform
## License / Copyright
This repository is licensed under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.en.html)
## 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](https://github.com/OpenEnergyPlatform/examples/tree/master/api).
## 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](https://github.com/OpenEnergyPlatform/oeplatform)
Set your connection token that you got from your local OEP instance
`LOCAL_OEP_TOKEN=<your_token>`
Finally, run
`tox`
Raw data
{
"_id": null,
"home_page": "https://github.com/openego/oedialect",
"name": "oedialect",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "postgres, open, energy, database, sql, rest",
"author": "MGlauer",
"author_email": "martinglauer89@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fe/5a/674d2a229b2404b248f8355b1580fc0c33efdb5e038f1d2f133ac62db8ba/oedialect-0.1.1.tar.gz",
"platform": null,
"description": "\ufeff<a href=\"http://oep.iks.cs.ovgu.de/\"><img align=\"right\" width=\"200\" height=\"200\" src=\"https://avatars2.githubusercontent.com/u/37101913?s=400&u=9b593cfdb6048a05ea6e72d333169a65e7c922be&v=4\" alt=\"OpenEnergyPlatform\"></a>\n\n# An [SQLAlchemy][0] [Dialect][1] for the [OEP][2]\n\nSQLAlchemy internally uses so called \"dialects\" to provide a consistent\ninterface to different database drivers. The `oedialect` supplies your\nSQLAlchemy installation with a dialect using the REST-API of the [Open\nEnergy Platform (OEP)][2]. In short, the `oedialect` allows you to use\nSQLAlchemy to down- and upload data to an OEP instance.\n\n[0]: https://www.sqlalchemy.org/\n[1]: https://docs.sqlalchemy.org/en/13/dialects/\n[2]: https://github.com/OpenEnergyPlatform/oeplatform\n\n## License / Copyright\n\nThis repository is licensed under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl-3.0.en.html)\n\n## Installation\n\n`pip install oedialect`\n\nOn MS-Windows make sure to install a version of `shapely` first.\n`conda install shapely -c conda-forge`\n\n## Tutorials\n\nYou can find tutorials and examples [here](https://github.com/OpenEnergyPlatform/examples/tree/master/api).\n\n\n## Testing\n\nTo run the tests locally, first install the `tox` test environment\n`pip install tox`\n\nYou need to setup a local instance of the [Open Energy Platform](https://github.com/OpenEnergyPlatform/oeplatform)\n\nSet your connection token that you got from your local OEP instance\n`LOCAL_OEP_TOKEN=<your_token>`\n\nFinally, run\n`tox`\n",
"bugtrack_url": null,
"license": null,
"summary": "SQL-Alchemy dialect for the OpenEnergy Platform",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/openego/oedialect"
},
"split_keywords": [
"postgres",
" open",
" energy",
" database",
" sql",
" rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7747b22039e440acec3d9508d3463bf8528ba364c5e801ec27b4b0d81bbe894",
"md5": "502f120cb5e6101e18b458e9ca4a95c9",
"sha256": "7ec2e63bce2d24b43ad2c68056f198bde5167ff0c0fc3dadc238ef5079ccfe1e"
},
"downloads": -1,
"filename": "oedialect-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "502f120cb5e6101e18b458e9ca4a95c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 31359,
"upload_time": "2024-04-15T14:25:54",
"upload_time_iso_8601": "2024-04-15T14:25:54.915985Z",
"url": "https://files.pythonhosted.org/packages/a7/74/7b22039e440acec3d9508d3463bf8528ba364c5e801ec27b4b0d81bbe894/oedialect-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe5a674d2a229b2404b248f8355b1580fc0c33efdb5e038f1d2f133ac62db8ba",
"md5": "a46a667404a00314ef72cc93b6323dec",
"sha256": "e71819a5f2d5ebf47f75851cc02cc0c9a3facf66a4d8e84a039dfd1ba1f5611c"
},
"downloads": -1,
"filename": "oedialect-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a46a667404a00314ef72cc93b6323dec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31848,
"upload_time": "2024-04-15T14:25:56",
"upload_time_iso_8601": "2024-04-15T14:25:56.226318Z",
"url": "https://files.pythonhosted.org/packages/fe/5a/674d2a229b2404b248f8355b1580fc0c33efdb5e038f1d2f133ac62db8ba/oedialect-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 14:25:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openego",
"github_project": "oedialect",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "oedialect"
}
JSON
