<!--
SPDX-FileCopyrightText: 2017-2022 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com>
SPDX-License-Identifier: MPL-2.0
-->
[](https://github.com/openstef/openstef-dbc/actions/workflows/python-build.yaml)
[](https://github.com/openstef/openstef-dbc/actions/workflows/reuse-compliance.yml)
[](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef-dbc)
# Openstef-dbc - Database connector for openstef (reference)
This repository houses the python package [openstef-dbc](https://pypi.org/project/openstef-dbc/), which provides a database interface to OpenSTEF (reference). It can be usefull to explorte [openstef](https://github.com/openstef/short-term-forecasting) and [openstef-reference](https://github.com/openstef/openstef-reference).
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [License](#license)
- [Licenses third-party libraries](#licenses-third-party-libraries)
- [Contributing](#contributing)
- [Contact](##contact)
## Install
1. Install by running
```shell
pip install openstef-dbc
```
3. Enjoy!
## Usage
This is a package with functionality to support the openstef workflow. Most important is the DataBase class.
This class give access to the data used by openstef-reference via a convenient interface. You can use it, for example, to retrieve a prediction job by running the following lines of code:
```python
from openstef_dbc.database import DataBase
db = DataBase(config)
pj = db.get_prediction_job(307)
```
Where `config` is a `pydantic.BaseSettings` object.
## License
This project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.
## Licenses third-party libraries
This project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.
## Contributing
Please read [CODE_OF_CONDUCT.md](https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md), [CONTRIBUTING.md](https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md) and [PROJECT_GOVERNANACE.md](https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us.
## Contact
Please read [SUPPORT.md](https://github.com/OpenSTEF/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the OpenSTEF project
Raw data
{
"_id": null,
"home_page": "https://github.com/openstef/openstef-dbc",
"name": "openstef-dbc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": null,
"keywords": "database, energy, forecasting, machinelearning",
"author": "Alliander N.V",
"author_email": "korte.termijn.prognoses@alliander.com",
"download_url": "https://files.pythonhosted.org/packages/0a/9c/8313ab2840004bd90c4b05e480f0f28539391cf179c2ece61d389c7e1c9d/openstef_dbc-3.7.6.tar.gz",
"platform": null,
"description": "<!--\nSPDX-FileCopyrightText: 2017-2022 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com>\n\nSPDX-License-Identifier: MPL-2.0\n-->\n[](https://github.com/openstef/openstef-dbc/actions/workflows/python-build.yaml)\n[](https://github.com/openstef/openstef-dbc/actions/workflows/reuse-compliance.yml)\n[](https://sonarcloud.io/dashboard?id=OpenSTEF_openstef-dbc)\n\n\n\n# Openstef-dbc - Database connector for openstef (reference)\n\nThis repository houses the python package [openstef-dbc](https://pypi.org/project/openstef-dbc/), which provides a database interface to OpenSTEF (reference). It can be usefull to explorte [openstef](https://github.com/openstef/short-term-forecasting) and [openstef-reference](https://github.com/openstef/openstef-reference). \n\n## Table of contents \n- [Install](#install)\n- [Usage](#usage)\n- [License](#license)\n- [Licenses third-party libraries](#licenses-third-party-libraries)\n- [Contributing](#contributing)\n- [Contact](##contact)\n\n## Install\n\n1. Install by running\n ```shell\n pip install openstef-dbc\n ``` \n3. Enjoy!\n\n## Usage\n\nThis is a package with functionality to support the openstef workflow. Most important is the DataBase class.\nThis class give access to the data used by openstef-reference via a convenient interface. You can use it, for example, to retrieve a prediction job by running the following lines of code:\n\n```python\nfrom openstef_dbc.database import DataBase\n\ndb = DataBase(config)\n\npj = db.get_prediction_job(307)\n```\nWhere `config` is a `pydantic.BaseSettings` object.\n\n## License\nThis project is licensed under the Mozilla Public License, version 2.0 - see LICENSE for details.\n\n## Licenses third-party libraries\nThis project includes third-party libraries, which are licensed under their own respective Open-Source licenses. SPDX-License-Identifier headers are used to show which license is applicable. The concerning license files can be found in the LICENSES directory.\n\n## Contributing\nPlease read [CODE_OF_CONDUCT.md](https://github.com/OpenSTEF/.github/blob/main/CODE_OF_CONDUCT.md), [CONTRIBUTING.md](https://github.com/OpenSTEF/.github/blob/main/CONTRIBUTING.md) and [PROJECT_GOVERNANACE.md](https://github.com/OpenSTEF/.github/blob/main/PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us.\n\n## Contact\nPlease read [SUPPORT.md](https://github.com/OpenSTEF/.github/blob/main/SUPPORT.md) for how to connect and get into contact with the OpenSTEF project\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "Database Connection for OpenSTEF",
"version": "3.7.6",
"project_urls": {
"Homepage": "https://github.com/openstef/openstef-dbc"
},
"split_keywords": [
"database",
" energy",
" forecasting",
" machinelearning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c9615b7491be023f2dda2331a1968ba497f0645fdffc8da5d0423ae07a5762d",
"md5": "9a5b1ba94f89ca89d0f2fcd5617e9165",
"sha256": "363a6c4d9fce700733dbebda04bc8f7f260d931e39da189ee3fb31e5794c5bf8"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a5b1ba94f89ca89d0f2fcd5617e9165",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 54519,
"upload_time": "2024-04-03T14:38:44",
"upload_time_iso_8601": "2024-04-03T14:38:44.471189Z",
"url": "https://files.pythonhosted.org/packages/6c/96/15b7491be023f2dda2331a1968ba497f0645fdffc8da5d0423ae07a5762d/openstef_dbc-3.7.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a9c8313ab2840004bd90c4b05e480f0f28539391cf179c2ece61d389c7e1c9d",
"md5": "724b009fa9db6d9f30ab2de3afcf0008",
"sha256": "153419766c2cddd619c56b196fd178e4a83e5af21832e6c47cf8ef704e5ef6b8"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.6.tar.gz",
"has_sig": false,
"md5_digest": "724b009fa9db6d9f30ab2de3afcf0008",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 44768,
"upload_time": "2024-04-03T14:38:46",
"upload_time_iso_8601": "2024-04-03T14:38:46.196675Z",
"url": "https://files.pythonhosted.org/packages/0a/9c/8313ab2840004bd90c4b05e480f0f28539391cf179c2ece61d389c7e1c9d/openstef_dbc-3.7.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 14:38:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openstef",
"github_project": "openstef-dbc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ciso8601",
"specs": [
[
"~=",
"2.3.0"
]
]
},
{
"name": "geopy",
"specs": [
[
"~=",
"2.3.0"
]
]
},
{
"name": "openstef",
"specs": [
[
"~=",
"3.4.4"
]
]
},
{
"name": "pydantic-settings",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"2.1.0"
]
]
},
{
"name": "influxdb-client",
"specs": [
[
"~=",
"1.36.1"
]
]
},
{
"name": "mysql-connector-python",
"specs": [
[
"~=",
"8.3.0"
]
]
},
{
"name": "PyMySQL",
"specs": [
[
"~=",
"1.0.2"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.28.1"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"~=",
"2.0.21"
]
]
}
],
"lcname": "openstef-dbc"
}
JSON
