Database Connection for OpenSTF
Project description
# Openstf-dbc - Database connector for openstf (reference)
This repository houses the python package [openstf-dbc](https://pypi.org/project/openstf-dbc/), which provides an interface to openstf (reference) databases.
Related projects:
- [openstf-reference](https://github.com/alliander-opensource/openstf-reference)
- [openstf](https://github.com/alliander-opensource/short-term-forecasting)
## Install
1. Install by running `pip install openstf-dbc`
2. Enjoy!
## Usage
This is a package with functionality to support the openstf workflow. Most important is the DataBase class.
This class give access to the data used by openstf-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 openstf_dbc.config.config import ConfigManager
from openstf_dbc.database import DataBase
config = ConfigManager.load_project_config(PROJECT_ROOT)
db = DataBase(config)
pj = db.get_prediction_job(307)
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 CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Contact
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openstf_dbc-2.1.0.tar.gz
(45.9 kB
view hashes)
Built Distribution
Close
Hashes for openstf_dbc-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b2a0a474e49ee6bf0b3453c6f7f9680df44abb460c8362830af02e8acb2de14 |
|
MD5 | 2c1b78e201daaef684e73e3d058c6b7c |
|
BLAKE2b-256 | 1c550e3605b290ccb1dfc5ed0230a1d96723c17f46b51ba0e7e8aba220325351 |