/openstef-dbc

Provides (company specific) database connector for the OpenSTEF package

Primary LanguagePythonMozilla Public License 2.0MPL-2.0

Python Build REUSE Compliance Check Quality Gate Status

Openstef-dbc - Database connector for openstef (reference)

This repository houses the python package openstef-dbc, which provides an interface to openstef (reference) databases.

Related projects:

Install

  1. Install by running pip install openstef-dbc
  2. 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:

from openstef_dbc.config.config import ConfigManager
from openstef_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 CODE_OF_CONDUCT.md, CONTRIBUTING.md and PROJECT_GOVERNANACE.md for details on the process for submitting pull requests to us.

Contact

Please read SUPPORT.md for how to connect and get into contact with the OpenSTEF project