<!--
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 explore [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/bc/79/8ca1e5b9ad65185567a0c21fcdd72a89fc7755d56c574ef469e4d827536c/openstef_dbc-3.7.21.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 explore [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.21",
"project_urls": {
"Homepage": "https://github.com/openstef/openstef-dbc"
},
"split_keywords": [
"database",
" energy",
" forecasting",
" machinelearning"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0f8407f6f10f730ab1514e92d60fcc28a807f59c492da8fd62a2f8df85395bce",
"md5": "8f1759808e224a276bdb728a2409db45",
"sha256": "b0783f489a4b937619706a1f8b81db8f9ad525bfb354cd8954c50a27611e1613"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f1759808e224a276bdb728a2409db45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 57951,
"upload_time": "2025-02-07T08:33:47",
"upload_time_iso_8601": "2025-02-07T08:33:47.194956Z",
"url": "https://files.pythonhosted.org/packages/0f/84/07f6f10f730ab1514e92d60fcc28a807f59c492da8fd62a2f8df85395bce/openstef_dbc-3.7.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bc798ca1e5b9ad65185567a0c21fcdd72a89fc7755d56c574ef469e4d827536c",
"md5": "6082650d217b63d9e1240bec838be940",
"sha256": "2fd01ac6f8d09e6f287cbc8b2f1d29e21e5c9d35b793bdb3b269a75c2d1cd042"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.21.tar.gz",
"has_sig": false,
"md5_digest": "6082650d217b63d9e1240bec838be940",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 47820,
"upload_time": "2025-02-07T08:33:48",
"upload_time_iso_8601": "2025-02-07T08:33:48.587563Z",
"url": "https://files.pythonhosted.org/packages/bc/79/8ca1e5b9ad65185567a0c21fcdd72a89fc7755d56c574ef469e4d827536c/openstef_dbc-3.7.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 08:33:48",
"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": "psycopg2-binary",
"specs": [
[
"~=",
"2.9.6"
]
]
},
{
"name": "PyMySQL",
"specs": [
[
"~=",
"1.0.2"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"~=",
"6.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.28.1"
]
]
},
{
"name": "SQLAlchemy",
"specs": []
}
],
"lcname": "openstef-dbc"
}
JSON
