Metadata-Version: 2.1
Name: openstf_dbc
Version: 1.0.2
Summary: Database Connection for OpenSTF
Home-page: https://github.com/alliander-opensource/openstf-db-connector
Author: Alliander N.V
Author-email: korte.termijn.prognoses@alliander.com
License: MPL-2.0
Description: <!--
        SPDX-FileCopyrightText: 2021 2017-2021 Alliander N.V. <korte.termijn.prognoses@alliander.com>
        
        SPDX-License-Identifier: MPL-2.0
        -->
        [![Python Build](https://github.com/alliander-opensource/openstf-db-connector/actions/workflows/python-build.yaml/badge.svg?branch=master)](https://github.com/alliander-opensource/openstf-db-connector/actions/workflows/python-build.yaml)
        [![REUSE Compliance Check](https://github.com/alliander-opensource/openstf-db-connector/actions/workflows/reuse-compliance.yml/badge.svg?branch=master)](https://github.com/alliander-opensource/openstf-db-connector/actions/workflows/reuse-compliance.yml)
        [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=alliander-opensource_openstf-db-connector&metric=alert_status)](https://sonarcloud.io/dashboard?id=alliander-opensource_openstf-db-connector)
        
        
        # Openstf-db-connector - 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.database import DataBase
        
        db = DataBase()
        
        pj = db.get_prediction_job(307)
        ```
        
        ## Contributing
        
        Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
        
        ## Contact
        
        korte.termijn.prognoses@alliander.com
        
Keywords: database,energy,forecasting,machinelearning
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
