<!--
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/52/9d/536f13d5f67cd2095e2651c76b5663ed4d1d13af5414fbb48ce96e0bc785/openstef_dbc-3.7.17.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.17",
"project_urls": {
"Homepage": "https://github.com/openstef/openstef-dbc"
},
"split_keywords": [
"database",
" energy",
" forecasting",
" machinelearning"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6d37640dbb0652d3f6b991ee9c3c6dfbf4dbf2c3ef4c3589362abfc64347e8d",
"md5": "9a257dd5102fb555737bbdeef754783c",
"sha256": "c2204772801b09bc6017d5c6374f1ccda691ffa1e93f2816b6b6517624b531ef"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a257dd5102fb555737bbdeef754783c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 56620,
"upload_time": "2024-11-22T11:07:27",
"upload_time_iso_8601": "2024-11-22T11:07:27.207624Z",
"url": "https://files.pythonhosted.org/packages/d6/d3/7640dbb0652d3f6b991ee9c3c6dfbf4dbf2c3ef4c3589362abfc64347e8d/openstef_dbc-3.7.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "529d536f13d5f67cd2095e2651c76b5663ed4d1d13af5414fbb48ce96e0bc785",
"md5": "af8440bcd0585e1473b926f9205c1c6b",
"sha256": "bede01666d6029745ca932df358dbb10cd29f99c5890cccfa60c5468aa2bb147"
},
"downloads": -1,
"filename": "openstef_dbc-3.7.17.tar.gz",
"has_sig": false,
"md5_digest": "af8440bcd0585e1473b926f9205c1c6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 46710,
"upload_time": "2024-11-22T11:07:31",
"upload_time_iso_8601": "2024-11-22T11:07:31.151010Z",
"url": "https://files.pythonhosted.org/packages/52/9d/536f13d5f67cd2095e2651c76b5663ed4d1d13af5414fbb48ce96e0bc785/openstef_dbc-3.7.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 11:07:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openstef",
"github_project": "openstef-dbc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "openstef-dbc"
}
JSON
