Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
openstef-dbc
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
openstef-dbc - npm Package Compare versions
+292
| Mozilla Public License Version 2.0 | ||
| 1. Definitions | ||
| 1.1. "Contributor" means each individual or legal entity that creates, contributes | ||
| to the creation of, or owns Covered Software. | ||
| 1.2. "Contributor Version" means the combination of the Contributions of others | ||
| (if any) used by a Contributor and that particular Contributor's Contribution. | ||
| 1.3. "Contribution" means Covered Software of a particular Contributor. | ||
| 1.4. "Covered Software" means Source Code Form to which the initial Contributor | ||
| has attached the notice in Exhibit A, the Executable Form of such Source Code | ||
| Form, and Modifications of such Source Code Form, in each case including portions | ||
| thereof. | ||
| 1.5. "Incompatible With Secondary Licenses" means | ||
| (a) that the initial Contributor has attached the notice described in Exhibit | ||
| B to the Covered Software; or | ||
| (b) that the Covered Software was made available under the terms of version | ||
| 1.1 or earlier of the License, but not also under the terms of a Secondary | ||
| License. | ||
| 1.6. "Executable Form" means any form of the work other than Source Code Form. | ||
| 1.7. "Larger Work" means a work that combines Covered Software with other | ||
| material, in a separate file or files, that is not Covered Software. | ||
| 1.8. "License" means this document. | ||
| 1.9. "Licensable" means having the right to grant, to the maximum extent possible, | ||
| whether at the time of the initial grant or subsequently, any and all of the | ||
| rights conveyed by this License. | ||
| 1.10. "Modifications" means any of the following: | ||
| (a) any file in Source Code Form that results from an addition to, deletion | ||
| from, or modification of the contents of Covered Software; or | ||
| (b) any new file in Source Code Form that contains any Covered Software. | ||
| 1.11. "Patent Claims" of a Contributor means any patent claim(s), including | ||
| without limitation, method, process, and apparatus claims, in any patent Licensable | ||
| by such Contributor that would be infringed, but for the grant of the License, | ||
| by the making, using, selling, offering for sale, having made, import, or | ||
| transfer of either its Contributions or its Contributor Version. | ||
| 1.12. "Secondary License" means either the GNU General Public License, Version | ||
| 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General | ||
| Public License, Version 3.0, or any later versions of those licenses. | ||
| 1.13. "Source Code Form" means the form of the work preferred for making modifications. | ||
| 1.14. "You" (or "Your") means an individual or a legal entity exercising rights | ||
| under this License. For legal entities, "You" includes any entity that controls, | ||
| is controlled by, or is under common control with You. For purposes of this | ||
| definition, "control" means (a) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or otherwise, | ||
| or (b) ownership of more than fifty percent (50%) of the outstanding shares | ||
| or beneficial ownership of such entity. | ||
| 2. License Grants and Conditions | ||
| 2.1. Grants | ||
| Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive | ||
| license: | ||
| (a) under intellectual property rights (other than patent or trademark) Licensable | ||
| by such Contributor to use, reproduce, make available, modify, display, perform, | ||
| distribute, and otherwise exploit its Contributions, either on an unmodified | ||
| basis, with Modifications, or as part of a Larger Work; and | ||
| (b) under Patent Claims of such Contributor to make, use, sell, offer for | ||
| sale, have made, import, and otherwise transfer either its Contributions or | ||
| its Contributor Version. | ||
| 2.2. Effective Date | ||
| The licenses granted in Section 2.1 with respect to any Contribution become | ||
| effective for each Contribution on the date the Contributor first distributes | ||
| such Contribution. | ||
| 2.3. Limitations on Grant Scope | ||
| The licenses granted in this Section 2 are the only rights granted under this | ||
| License. No additional rights or licenses will be implied from the distribution | ||
| or licensing of Covered Software under this License. Notwithstanding Section | ||
| 2.1(b) above, no patent license is granted by a Contributor: | ||
| (a) for any code that a Contributor has removed from Covered Software; or | ||
| (b) for infringements caused by: (i) Your and any other third party's modifications | ||
| of Covered Software, or (ii) the combination of its Contributions with other | ||
| software (except as part of its Contributor Version); or | ||
| (c) under Patent Claims infringed by Covered Software in the absence of its | ||
| Contributions. | ||
| This License does not grant any rights in the trademarks, service marks, or | ||
| logos of any Contributor (except as may be necessary to comply with the notice | ||
| requirements in Section 3.4). | ||
| 2.4. Subsequent Licenses | ||
| No Contributor makes additional grants as a result of Your choice to distribute | ||
| the Covered Software under a subsequent version of this License (see Section | ||
| 10.2) or under the terms of a Secondary License (if permitted under the terms | ||
| of Section 3.3). | ||
| 2.5. Representation | ||
| Each Contributor represents that the Contributor believes its Contributions | ||
| are its original creation(s) or it has sufficient rights to grant the rights | ||
| to its Contributions conveyed by this License. | ||
| 2.6. Fair Use | ||
| This License is not intended to limit any rights You have under applicable | ||
| copyright doctrines of fair use, fair dealing, or other equivalents. | ||
| 2.7. Conditions | ||
| Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in | ||
| Section 2.1. | ||
| 3. Responsibilities | ||
| 3.1. Distribution of Source Form | ||
| All distribution of Covered Software in Source Code Form, including any Modifications | ||
| that You create or to which You contribute, must be under the terms of this | ||
| License. You must inform recipients that the Source Code Form of the Covered | ||
| Software is governed by the terms of this License, and how they can obtain | ||
| a copy of this License. You may not attempt to alter or restrict the recipients' | ||
| rights in the Source Code Form. | ||
| 3.2. Distribution of Executable Form | ||
| If You distribute Covered Software in Executable Form then: | ||
| (a) such Covered Software must also be made available in Source Code Form, | ||
| as described in Section 3.1, and You must inform recipients of the Executable | ||
| Form how they can obtain a copy of such Source Code Form by reasonable means | ||
| in a timely manner, at a charge no more than the cost of distribution to the | ||
| recipient; and | ||
| (b) You may distribute such Executable Form under the terms of this License, | ||
| or sublicense it under different terms, provided that the license for the | ||
| Executable Form does not attempt to limit or alter the recipients' rights | ||
| in the Source Code Form under this License. | ||
| 3.3. Distribution of a Larger Work | ||
| You may create and distribute a Larger Work under terms of Your choice, provided | ||
| that You also comply with the requirements of this License for the Covered | ||
| Software. If the Larger Work is a combination of Covered Software with a work | ||
| governed by one or more Secondary Licenses, and the Covered Software is not | ||
| Incompatible With Secondary Licenses, this License permits You to additionally | ||
| distribute such Covered Software under the terms of such Secondary License(s), | ||
| so that the recipient of the Larger Work may, at their option, further distribute | ||
| the Covered Software under the terms of either this License or such Secondary | ||
| License(s). | ||
| 3.4. Notices | ||
| You may not remove or alter the substance of any license notices (including | ||
| copyright notices, patent notices, disclaimers of warranty, or limitations | ||
| of liability) contained within the Source Code Form of the Covered Software, | ||
| except that You may alter any license notices to the extent required to remedy | ||
| known factual inaccuracies. | ||
| 3.5. Application of Additional Terms | ||
| You may choose to offer, and to charge a fee for, warranty, support, indemnity | ||
| or liability obligations to one or more recipients of Covered Software. However, | ||
| You may do so only on Your own behalf, and not on behalf of any Contributor. | ||
| You must make it absolutely clear that any such warranty, support, indemnity, | ||
| or liability obligation is offered by You alone, and You hereby agree to indemnify | ||
| every Contributor for any liability incurred by such Contributor as a result | ||
| of warranty, support, indemnity or liability terms You offer. You may include | ||
| additional disclaimers of warranty and limitations of liability specific to | ||
| any jurisdiction. | ||
| 4. Inability to Comply Due to Statute or Regulation | ||
| If it is impossible for You to comply with any of the terms of this License | ||
| with respect to some or all of the Covered Software due to statute, judicial | ||
| order, or regulation then You must: (a) comply with the terms of this License | ||
| to the maximum extent possible; and (b) describe the limitations and the code | ||
| they affect. Such description must be placed in a text file included with | ||
| all distributions of the Covered Software under this License. Except to the | ||
| extent prohibited by statute or regulation, such description must be sufficiently | ||
| detailed for a recipient of ordinary skill to be able to understand it. | ||
| 5. Termination | ||
| 5.1. The rights granted under this License will terminate automatically if | ||
| You fail to comply with any of its terms. However, if You become compliant, | ||
| then the rights granted under this License from a particular Contributor are | ||
| reinstated (a) provisionally, unless and until such Contributor explicitly | ||
| and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor | ||
| fails to notify You of the non-compliance by some reasonable means prior to | ||
| 60 days after You have come back into compliance. Moreover, Your grants from | ||
| a particular Contributor are reinstated on an ongoing basis if such Contributor | ||
| notifies You of the non-compliance by some reasonable means, this is the first | ||
| time You have received notice of non-compliance with this License from such | ||
| Contributor, and You become compliant prior to 30 days after Your receipt | ||
| of the notice. | ||
| 5.2. If You initiate litigation against any entity by asserting a patent infringement | ||
| claim (excluding declaratory judgment actions, counter-claims, and cross-claims) | ||
| alleging that a Contributor Version directly or indirectly infringes any patent, | ||
| then the rights granted to You by any and all Contributors for the Covered | ||
| Software under Section 2.1 of this License shall terminate. | ||
| 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end | ||
| user license agreements (excluding distributors and resellers) which have | ||
| been validly granted by You or Your distributors under this License prior | ||
| to termination shall survive termination. | ||
| 6. Disclaimer of Warranty | ||
| Covered Software is provided under this License on an "as is" basis, without | ||
| warranty of any kind, either expressed, implied, or statutory, including, | ||
| without limitation, warranties that the Covered Software is free of defects, | ||
| merchantable, fit for a particular purpose or non-infringing. The entire risk | ||
| as to the quality and performance of the Covered Software is with You. Should | ||
| any Covered Software prove defective in any respect, You (not any Contributor) | ||
| assume the cost of any necessary servicing, repair, or correction. This disclaimer | ||
| of warranty constitutes an essential part of this License. No use of any Covered | ||
| Software is authorized under this License except under this disclaimer. | ||
| 7. Limitation of Liability | ||
| Under no circumstances and under no legal theory, whether tort (including | ||
| negligence), contract, or otherwise, shall any Contributor, or anyone who | ||
| distributes Covered Software as permitted above, be liable to You for any | ||
| direct, indirect, special, incidental, or consequential damages of any character | ||
| including, without limitation, damages for lost profits, loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all other commercial | ||
| damages or losses, even if such party shall have been informed of the possibility | ||
| of such damages. This limitation of liability shall not apply to liability | ||
| for death or personal injury resulting from such party's negligence to the | ||
| extent applicable law prohibits such limitation. Some jurisdictions do not | ||
| allow the exclusion or limitation of incidental or consequential damages, | ||
| so this exclusion and limitation may not apply to You. | ||
| 8. Litigation | ||
| Any litigation relating to this License may be brought only in the courts | ||
| of a jurisdiction where the defendant maintains its principal place of business | ||
| and such litigation shall be governed by laws of that jurisdiction, without | ||
| reference to its conflict-of-law provisions. Nothing in this Section shall | ||
| prevent a party's ability to bring cross-claims or counter-claims. | ||
| 9. Miscellaneous | ||
| This License represents the complete agreement concerning the subject matter | ||
| hereof. If any provision of this License is held to be unenforceable, such | ||
| provision shall be reformed only to the extent necessary to make it enforceable. | ||
| Any law or regulation which provides that the language of a contract shall | ||
| be construed against the drafter shall not be used to construe this License | ||
| against a Contributor. | ||
| 10. Versions of the License | ||
| 10.1. New Versions | ||
| Mozilla Foundation is the license steward. Except as provided in Section 10.3, | ||
| no one other than the license steward has the right to modify or publish new | ||
| versions of this License. Each version will be given a distinguishing version | ||
| number. | ||
| 10.2. Effect of New Versions | ||
| You may distribute the Covered Software under the terms of the version of | ||
| the License under which You originally received the Covered Software, or under | ||
| the terms of any subsequent version published by the license steward. | ||
| 10.3. Modified Versions | ||
| If you create software not governed by this License, and you want to create | ||
| a new license for such software, you may create and use a modified version | ||
| of this License if you rename the license and remove any references to the | ||
| name of the license steward (except to note that such modified license differs | ||
| from this License). | ||
| 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses | ||
| If You choose to distribute Source Code Form that is Incompatible With Secondary | ||
| Licenses under the terms of this version of the License, the notice described | ||
| in Exhibit B of this License must be attached. | ||
| Exhibit A - Source Code Form License Notice | ||
| This Source Code Form is subject to the terms of the Mozilla Public License, | ||
| v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain | ||
| one at http://mozilla.org/MPL/2.0/. | ||
| If it is not possible or desirable to put the notice in a particular file, | ||
| then You may include the notice in a location (such as a LICENSE file in a | ||
| relevant directory) where a recipient would be likely to look for such a notice. | ||
| You may add additional accurate notices of copyright ownership. | ||
| Exhibit B - "Incompatible With Secondary Licenses" Notice | ||
| This Source Code Form is "Incompatible With Secondary Licenses", as defined | ||
| by the Mozilla Public License, v. 2.0. |
+97
| Metadata-Version: 2.4 | ||
| Name: openstef_dbc | ||
| Version: 3.8.7 | ||
| Summary: Database Connection for OpenSTEF | ||
| Home-page: https://github.com/openstef/openstef-dbc | ||
| Author: Alliander N.V | ||
| Author-email: korte.termijn.prognoses@alliander.com | ||
| License: MPL-2.0 | ||
| Keywords: database,energy,forecasting,machinelearning | ||
| 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.12 | ||
| Classifier: Programming Language :: Python :: 3.13 | ||
| Requires-Python: >=3.12.0 | ||
| Description-Content-Type: text/markdown | ||
| License-File: LICENSE | ||
| Requires-Dist: ciso8601~=2.3.0 | ||
| Requires-Dist: geopy~=2.3.0 | ||
| Requires-Dist: openstef~=3.4.87 | ||
| Requires-Dist: pydantic-settings<3.0.0,>=2.1.0 | ||
| Requires-Dist: influxdb-client~=1.36.1 | ||
| Requires-Dist: mysql-connector-python>=9.1.0 | ||
| Requires-Dist: psycopg2-binary~=2.9.6 | ||
| Requires-Dist: PyMySQL~=1.0.2 | ||
| Requires-Dist: PyYAML~=6.0 | ||
| Requires-Dist: requests~=2.28.1 | ||
| Requires-Dist: SQLAlchemy | ||
| Dynamic: author | ||
| Dynamic: author-email | ||
| Dynamic: classifier | ||
| Dynamic: description | ||
| Dynamic: description-content-type | ||
| Dynamic: home-page | ||
| Dynamic: keywords | ||
| Dynamic: license | ||
| Dynamic: license-file | ||
| Dynamic: requires-dist | ||
| Dynamic: requires-python | ||
| Dynamic: summary | ||
| <!-- | ||
| 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 |
+28
| openstef_dbc/__init__.py,sha256=xiEcvYe7NFTxc1CH6PjtvKXr7oRZXvoGcSVI8SZEoxc,934 | ||
| openstef_dbc/__main__.py,sha256=h-XbvSr5ajS-jfwF3c_j5k5XUou9DKMgoTDB4vCCV0g,150 | ||
| openstef_dbc/data_interface.py,sha256=ZOV1DXZNG94YEGf7M0aOi_lxg2XqUmWBVO080i6S44I,12634 | ||
| openstef_dbc/database.py,sha256=_G5PVOFq7NYkLyPtgHdREGhB6Y4ehY3mvKNIWiDyZ-4,5656 | ||
| openstef_dbc/ktp_api.py,sha256=CCkrKR4U8Yw1rxPApC4zkf0Thh1hEJN7-KmQTiSZ1As,13530 | ||
| openstef_dbc/settings.py,sha256=87H-gNnbgOERVMdonOwthCwa3Rx68_mqnCJt-Yxg2sk,992 | ||
| openstef_dbc/utils.py,sha256=zg69yrRU8h4Li0ss294pKFBFftjwmFJXL06dZXMNBAU,2542 | ||
| openstef_dbc/log/__init__.py,sha256=h-XbvSr5ajS-jfwF3c_j5k5XUou9DKMgoTDB4vCCV0g,150 | ||
| openstef_dbc/log/logging.py,sha256=nx7MiSoFBAGLChFwplhFpuqBSXHS7rFNGve5qyMy-8Y,8932 | ||
| openstef_dbc/log/processors.py,sha256=vJH6wEXtMlcxWPSMP5NYtOuIOGLchBRlE8qWkBAyRQA,1455 | ||
| openstef_dbc/models/__init__.py,sha256=h-XbvSr5ajS-jfwF3c_j5k5XUou9DKMgoTDB4vCCV0g,150 | ||
| openstef_dbc/models/measurement.py,sha256=Zecyj58K-FcWTcsOZdScyg2crfD7y1EgmADnCszmG44,633 | ||
| openstef_dbc/models/switch_state.py,sha256=Nm-hKCJh0TsNB9g-XwS8kD2fDEFuBmMhiD_o66bHYAk,510 | ||
| openstef_dbc/services/__init__.py,sha256=h-XbvSr5ajS-jfwF3c_j5k5XUou9DKMgoTDB4vCCV0g,150 | ||
| openstef_dbc/services/ems.py,sha256=WTR6lKmfnS3tFnHV89cWUP9mtzhy5QWgbgc1gDrpbYk,14088 | ||
| openstef_dbc/services/model_input.py,sha256=ldPDZjbR-xKk8Wfh1SqG1lIXMZgHPCL27thJuwt7TRw,10949 | ||
| openstef_dbc/services/prediction_job.py,sha256=Mwy0bfXIWqOcMBpjvhco-tlQ0pT41PBdv1XzUny8xC4,14333 | ||
| openstef_dbc/services/predictions.py,sha256=rjUwaVfzkMRY-2h1ysr24dZdkVTaqKA9fCnNon_RSlY,14597 | ||
| openstef_dbc/services/predictor.py,sha256=yRUVN209INpbHLHfmsDSiisutzHbRE9cP2uw5GVaGjc,11559 | ||
| openstef_dbc/services/splitting.py,sha256=EdzxIAHwsDCTe1WjV7cJXOf1OP9n0I3UIlr0CWvWLiE,9943 | ||
| openstef_dbc/services/systems.py,sha256=2flX6XNc7u09NxowG4T7Pxqbc0wJROJTebirmIFZ0z4,5509 | ||
| openstef_dbc/services/weather.py,sha256=z1PRAquy0je06E3-2aXlg4GIUTOPjiyEDRnSPmczrVM,16568 | ||
| openstef_dbc/services/write.py,sha256=Wsp8fR3in-m9ySeMpmDslO6hMRVqT3lwD2Zg9Zlndeg,23950 | ||
| openstef_dbc-3.8.7.dist-info/licenses/LICENSE,sha256=7Pm2fWFFHHUG5lDHed1vl5CjzxObIXQglnYsEdtjo_k,14907 | ||
| openstef_dbc-3.8.7.dist-info/METADATA,sha256=KBdXhdGKyrddFZfIqAilWh8T0m9S027J1LhpVcx4FXc,4131 | ||
| openstef_dbc-3.8.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91 | ||
| openstef_dbc-3.8.7.dist-info/top_level.txt,sha256=NDfhsz6WPBQPboO_X9K6xzA0PKNlu7DkyQwloG7GSFQ,13 | ||
| openstef_dbc-3.8.7.dist-info/RECORD,, |
| openstef_dbc |
+5
| Wheel-Version: 1.0 | ||
| Generator: setuptools (80.9.0) | ||
| Root-Is-Purelib: true | ||
| Tag: py3-none-any | ||
-292
| Mozilla Public License Version 2.0 | ||
| 1. Definitions | ||
| 1.1. "Contributor" means each individual or legal entity that creates, contributes | ||
| to the creation of, or owns Covered Software. | ||
| 1.2. "Contributor Version" means the combination of the Contributions of others | ||
| (if any) used by a Contributor and that particular Contributor's Contribution. | ||
| 1.3. "Contribution" means Covered Software of a particular Contributor. | ||
| 1.4. "Covered Software" means Source Code Form to which the initial Contributor | ||
| has attached the notice in Exhibit A, the Executable Form of such Source Code | ||
| Form, and Modifications of such Source Code Form, in each case including portions | ||
| thereof. | ||
| 1.5. "Incompatible With Secondary Licenses" means | ||
| (a) that the initial Contributor has attached the notice described in Exhibit | ||
| B to the Covered Software; or | ||
| (b) that the Covered Software was made available under the terms of version | ||
| 1.1 or earlier of the License, but not also under the terms of a Secondary | ||
| License. | ||
| 1.6. "Executable Form" means any form of the work other than Source Code Form. | ||
| 1.7. "Larger Work" means a work that combines Covered Software with other | ||
| material, in a separate file or files, that is not Covered Software. | ||
| 1.8. "License" means this document. | ||
| 1.9. "Licensable" means having the right to grant, to the maximum extent possible, | ||
| whether at the time of the initial grant or subsequently, any and all of the | ||
| rights conveyed by this License. | ||
| 1.10. "Modifications" means any of the following: | ||
| (a) any file in Source Code Form that results from an addition to, deletion | ||
| from, or modification of the contents of Covered Software; or | ||
| (b) any new file in Source Code Form that contains any Covered Software. | ||
| 1.11. "Patent Claims" of a Contributor means any patent claim(s), including | ||
| without limitation, method, process, and apparatus claims, in any patent Licensable | ||
| by such Contributor that would be infringed, but for the grant of the License, | ||
| by the making, using, selling, offering for sale, having made, import, or | ||
| transfer of either its Contributions or its Contributor Version. | ||
| 1.12. "Secondary License" means either the GNU General Public License, Version | ||
| 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General | ||
| Public License, Version 3.0, or any later versions of those licenses. | ||
| 1.13. "Source Code Form" means the form of the work preferred for making modifications. | ||
| 1.14. "You" (or "Your") means an individual or a legal entity exercising rights | ||
| under this License. For legal entities, "You" includes any entity that controls, | ||
| is controlled by, or is under common control with You. For purposes of this | ||
| definition, "control" means (a) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or otherwise, | ||
| or (b) ownership of more than fifty percent (50%) of the outstanding shares | ||
| or beneficial ownership of such entity. | ||
| 2. License Grants and Conditions | ||
| 2.1. Grants | ||
| Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive | ||
| license: | ||
| (a) under intellectual property rights (other than patent or trademark) Licensable | ||
| by such Contributor to use, reproduce, make available, modify, display, perform, | ||
| distribute, and otherwise exploit its Contributions, either on an unmodified | ||
| basis, with Modifications, or as part of a Larger Work; and | ||
| (b) under Patent Claims of such Contributor to make, use, sell, offer for | ||
| sale, have made, import, and otherwise transfer either its Contributions or | ||
| its Contributor Version. | ||
| 2.2. Effective Date | ||
| The licenses granted in Section 2.1 with respect to any Contribution become | ||
| effective for each Contribution on the date the Contributor first distributes | ||
| such Contribution. | ||
| 2.3. Limitations on Grant Scope | ||
| The licenses granted in this Section 2 are the only rights granted under this | ||
| License. No additional rights or licenses will be implied from the distribution | ||
| or licensing of Covered Software under this License. Notwithstanding Section | ||
| 2.1(b) above, no patent license is granted by a Contributor: | ||
| (a) for any code that a Contributor has removed from Covered Software; or | ||
| (b) for infringements caused by: (i) Your and any other third party's modifications | ||
| of Covered Software, or (ii) the combination of its Contributions with other | ||
| software (except as part of its Contributor Version); or | ||
| (c) under Patent Claims infringed by Covered Software in the absence of its | ||
| Contributions. | ||
| This License does not grant any rights in the trademarks, service marks, or | ||
| logos of any Contributor (except as may be necessary to comply with the notice | ||
| requirements in Section 3.4). | ||
| 2.4. Subsequent Licenses | ||
| No Contributor makes additional grants as a result of Your choice to distribute | ||
| the Covered Software under a subsequent version of this License (see Section | ||
| 10.2) or under the terms of a Secondary License (if permitted under the terms | ||
| of Section 3.3). | ||
| 2.5. Representation | ||
| Each Contributor represents that the Contributor believes its Contributions | ||
| are its original creation(s) or it has sufficient rights to grant the rights | ||
| to its Contributions conveyed by this License. | ||
| 2.6. Fair Use | ||
| This License is not intended to limit any rights You have under applicable | ||
| copyright doctrines of fair use, fair dealing, or other equivalents. | ||
| 2.7. Conditions | ||
| Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in | ||
| Section 2.1. | ||
| 3. Responsibilities | ||
| 3.1. Distribution of Source Form | ||
| All distribution of Covered Software in Source Code Form, including any Modifications | ||
| that You create or to which You contribute, must be under the terms of this | ||
| License. You must inform recipients that the Source Code Form of the Covered | ||
| Software is governed by the terms of this License, and how they can obtain | ||
| a copy of this License. You may not attempt to alter or restrict the recipients' | ||
| rights in the Source Code Form. | ||
| 3.2. Distribution of Executable Form | ||
| If You distribute Covered Software in Executable Form then: | ||
| (a) such Covered Software must also be made available in Source Code Form, | ||
| as described in Section 3.1, and You must inform recipients of the Executable | ||
| Form how they can obtain a copy of such Source Code Form by reasonable means | ||
| in a timely manner, at a charge no more than the cost of distribution to the | ||
| recipient; and | ||
| (b) You may distribute such Executable Form under the terms of this License, | ||
| or sublicense it under different terms, provided that the license for the | ||
| Executable Form does not attempt to limit or alter the recipients' rights | ||
| in the Source Code Form under this License. | ||
| 3.3. Distribution of a Larger Work | ||
| You may create and distribute a Larger Work under terms of Your choice, provided | ||
| that You also comply with the requirements of this License for the Covered | ||
| Software. If the Larger Work is a combination of Covered Software with a work | ||
| governed by one or more Secondary Licenses, and the Covered Software is not | ||
| Incompatible With Secondary Licenses, this License permits You to additionally | ||
| distribute such Covered Software under the terms of such Secondary License(s), | ||
| so that the recipient of the Larger Work may, at their option, further distribute | ||
| the Covered Software under the terms of either this License or such Secondary | ||
| License(s). | ||
| 3.4. Notices | ||
| You may not remove or alter the substance of any license notices (including | ||
| copyright notices, patent notices, disclaimers of warranty, or limitations | ||
| of liability) contained within the Source Code Form of the Covered Software, | ||
| except that You may alter any license notices to the extent required to remedy | ||
| known factual inaccuracies. | ||
| 3.5. Application of Additional Terms | ||
| You may choose to offer, and to charge a fee for, warranty, support, indemnity | ||
| or liability obligations to one or more recipients of Covered Software. However, | ||
| You may do so only on Your own behalf, and not on behalf of any Contributor. | ||
| You must make it absolutely clear that any such warranty, support, indemnity, | ||
| or liability obligation is offered by You alone, and You hereby agree to indemnify | ||
| every Contributor for any liability incurred by such Contributor as a result | ||
| of warranty, support, indemnity or liability terms You offer. You may include | ||
| additional disclaimers of warranty and limitations of liability specific to | ||
| any jurisdiction. | ||
| 4. Inability to Comply Due to Statute or Regulation | ||
| If it is impossible for You to comply with any of the terms of this License | ||
| with respect to some or all of the Covered Software due to statute, judicial | ||
| order, or regulation then You must: (a) comply with the terms of this License | ||
| to the maximum extent possible; and (b) describe the limitations and the code | ||
| they affect. Such description must be placed in a text file included with | ||
| all distributions of the Covered Software under this License. Except to the | ||
| extent prohibited by statute or regulation, such description must be sufficiently | ||
| detailed for a recipient of ordinary skill to be able to understand it. | ||
| 5. Termination | ||
| 5.1. The rights granted under this License will terminate automatically if | ||
| You fail to comply with any of its terms. However, if You become compliant, | ||
| then the rights granted under this License from a particular Contributor are | ||
| reinstated (a) provisionally, unless and until such Contributor explicitly | ||
| and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor | ||
| fails to notify You of the non-compliance by some reasonable means prior to | ||
| 60 days after You have come back into compliance. Moreover, Your grants from | ||
| a particular Contributor are reinstated on an ongoing basis if such Contributor | ||
| notifies You of the non-compliance by some reasonable means, this is the first | ||
| time You have received notice of non-compliance with this License from such | ||
| Contributor, and You become compliant prior to 30 days after Your receipt | ||
| of the notice. | ||
| 5.2. If You initiate litigation against any entity by asserting a patent infringement | ||
| claim (excluding declaratory judgment actions, counter-claims, and cross-claims) | ||
| alleging that a Contributor Version directly or indirectly infringes any patent, | ||
| then the rights granted to You by any and all Contributors for the Covered | ||
| Software under Section 2.1 of this License shall terminate. | ||
| 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end | ||
| user license agreements (excluding distributors and resellers) which have | ||
| been validly granted by You or Your distributors under this License prior | ||
| to termination shall survive termination. | ||
| 6. Disclaimer of Warranty | ||
| Covered Software is provided under this License on an "as is" basis, without | ||
| warranty of any kind, either expressed, implied, or statutory, including, | ||
| without limitation, warranties that the Covered Software is free of defects, | ||
| merchantable, fit for a particular purpose or non-infringing. The entire risk | ||
| as to the quality and performance of the Covered Software is with You. Should | ||
| any Covered Software prove defective in any respect, You (not any Contributor) | ||
| assume the cost of any necessary servicing, repair, or correction. This disclaimer | ||
| of warranty constitutes an essential part of this License. No use of any Covered | ||
| Software is authorized under this License except under this disclaimer. | ||
| 7. Limitation of Liability | ||
| Under no circumstances and under no legal theory, whether tort (including | ||
| negligence), contract, or otherwise, shall any Contributor, or anyone who | ||
| distributes Covered Software as permitted above, be liable to You for any | ||
| direct, indirect, special, incidental, or consequential damages of any character | ||
| including, without limitation, damages for lost profits, loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all other commercial | ||
| damages or losses, even if such party shall have been informed of the possibility | ||
| of such damages. This limitation of liability shall not apply to liability | ||
| for death or personal injury resulting from such party's negligence to the | ||
| extent applicable law prohibits such limitation. Some jurisdictions do not | ||
| allow the exclusion or limitation of incidental or consequential damages, | ||
| so this exclusion and limitation may not apply to You. | ||
| 8. Litigation | ||
| Any litigation relating to this License may be brought only in the courts | ||
| of a jurisdiction where the defendant maintains its principal place of business | ||
| and such litigation shall be governed by laws of that jurisdiction, without | ||
| reference to its conflict-of-law provisions. Nothing in this Section shall | ||
| prevent a party's ability to bring cross-claims or counter-claims. | ||
| 9. Miscellaneous | ||
| This License represents the complete agreement concerning the subject matter | ||
| hereof. If any provision of this License is held to be unenforceable, such | ||
| provision shall be reformed only to the extent necessary to make it enforceable. | ||
| Any law or regulation which provides that the language of a contract shall | ||
| be construed against the drafter shall not be used to construe this License | ||
| against a Contributor. | ||
| 10. Versions of the License | ||
| 10.1. New Versions | ||
| Mozilla Foundation is the license steward. Except as provided in Section 10.3, | ||
| no one other than the license steward has the right to modify or publish new | ||
| versions of this License. Each version will be given a distinguishing version | ||
| number. | ||
| 10.2. Effect of New Versions | ||
| You may distribute the Covered Software under the terms of the version of | ||
| the License under which You originally received the Covered Software, or under | ||
| the terms of any subsequent version published by the license steward. | ||
| 10.3. Modified Versions | ||
| If you create software not governed by this License, and you want to create | ||
| a new license for such software, you may create and use a modified version | ||
| of this License if you rename the license and remove any references to the | ||
| name of the license steward (except to note that such modified license differs | ||
| from this License). | ||
| 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses | ||
| If You choose to distribute Source Code Form that is Incompatible With Secondary | ||
| Licenses under the terms of this version of the License, the notice described | ||
| in Exhibit B of this License must be attached. | ||
| Exhibit A - Source Code Form License Notice | ||
| This Source Code Form is subject to the terms of the Mozilla Public License, | ||
| v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain | ||
| one at http://mozilla.org/MPL/2.0/. | ||
| If it is not possible or desirable to put the notice in a particular file, | ||
| then You may include the notice in a location (such as a LICENSE file in a | ||
| relevant directory) where a recipient would be likely to look for such a notice. | ||
| You may add additional accurate notices of copyright ownership. | ||
| Exhibit B - "Incompatible With Secondary Licenses" Notice | ||
| This Source Code Form is "Incompatible With Secondary Licenses", as defined | ||
| by the Mozilla Public License, v. 2.0. |
| Metadata-Version: 2.4 | ||
| Name: openstef_dbc | ||
| Version: 3.8.6 | ||
| Summary: Database Connection for OpenSTEF | ||
| Home-page: https://github.com/openstef/openstef-dbc | ||
| Author: Alliander N.V | ||
| Author-email: korte.termijn.prognoses@alliander.com | ||
| License: MPL-2.0 | ||
| Keywords: database,energy,forecasting,machinelearning | ||
| 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.12 | ||
| Classifier: Programming Language :: Python :: 3.13 | ||
| Requires-Python: >=3.12.0 | ||
| Description-Content-Type: text/markdown | ||
| License-File: LICENSE | ||
| Requires-Dist: ciso8601~=2.3.0 | ||
| Requires-Dist: geopy~=2.3.0 | ||
| Requires-Dist: openstef~=3.4.87 | ||
| Requires-Dist: pydantic-settings<3.0.0,>=2.1.0 | ||
| Requires-Dist: influxdb-client~=1.36.1 | ||
| Requires-Dist: mysql-connector-python>=9.1.0 | ||
| Requires-Dist: psycopg2-binary~=2.9.6 | ||
| Requires-Dist: PyMySQL~=1.0.2 | ||
| Requires-Dist: PyYAML~=6.0 | ||
| Requires-Dist: requests~=2.28.1 | ||
| Requires-Dist: SQLAlchemy | ||
| Dynamic: author | ||
| Dynamic: author-email | ||
| Dynamic: classifier | ||
| Dynamic: description | ||
| Dynamic: description-content-type | ||
| Dynamic: home-page | ||
| Dynamic: keywords | ||
| Dynamic: license | ||
| Dynamic: license-file | ||
| Dynamic: requires-dist | ||
| Dynamic: requires-python | ||
| Dynamic: summary | ||
| <!-- | ||
| 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 |
| ciso8601~=2.3.0 | ||
| geopy~=2.3.0 | ||
| openstef~=3.4.87 | ||
| pydantic-settings<3.0.0,>=2.1.0 | ||
| influxdb-client~=1.36.1 | ||
| mysql-connector-python>=9.1.0 | ||
| psycopg2-binary~=2.9.6 | ||
| PyMySQL~=1.0.2 | ||
| PyYAML~=6.0 | ||
| requests~=2.28.1 | ||
| SQLAlchemy |
| LICENSE | ||
| README.md | ||
| setup.cfg | ||
| setup.py | ||
| openstef_dbc/__init__.py | ||
| openstef_dbc/__main__.py | ||
| openstef_dbc/data_interface.py | ||
| openstef_dbc/database.py | ||
| openstef_dbc/ktp_api.py | ||
| openstef_dbc/settings.py | ||
| openstef_dbc/utils.py | ||
| openstef_dbc.egg-info/PKG-INFO | ||
| openstef_dbc.egg-info/SOURCES.txt | ||
| openstef_dbc.egg-info/dependency_links.txt | ||
| openstef_dbc.egg-info/requires.txt | ||
| openstef_dbc.egg-info/top_level.txt | ||
| openstef_dbc/log/__init__.py | ||
| openstef_dbc/log/logging.py | ||
| openstef_dbc/log/processors.py | ||
| openstef_dbc/models/__init__.py | ||
| openstef_dbc/models/measurement.py | ||
| openstef_dbc/models/switch_state.py | ||
| openstef_dbc/services/__init__.py | ||
| openstef_dbc/services/ems.py | ||
| openstef_dbc/services/model_input.py | ||
| openstef_dbc/services/prediction_job.py | ||
| openstef_dbc/services/predictions.py | ||
| openstef_dbc/services/predictor.py | ||
| openstef_dbc/services/splitting.py | ||
| openstef_dbc/services/systems.py | ||
| openstef_dbc/services/weather.py | ||
| openstef_dbc/services/write.py |
| openstef_dbc |
-97
| Metadata-Version: 2.4 | ||
| Name: openstef_dbc | ||
| Version: 3.8.6 | ||
| Summary: Database Connection for OpenSTEF | ||
| Home-page: https://github.com/openstef/openstef-dbc | ||
| Author: Alliander N.V | ||
| Author-email: korte.termijn.prognoses@alliander.com | ||
| License: MPL-2.0 | ||
| Keywords: database,energy,forecasting,machinelearning | ||
| 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.12 | ||
| Classifier: Programming Language :: Python :: 3.13 | ||
| Requires-Python: >=3.12.0 | ||
| Description-Content-Type: text/markdown | ||
| License-File: LICENSE | ||
| Requires-Dist: ciso8601~=2.3.0 | ||
| Requires-Dist: geopy~=2.3.0 | ||
| Requires-Dist: openstef~=3.4.87 | ||
| Requires-Dist: pydantic-settings<3.0.0,>=2.1.0 | ||
| Requires-Dist: influxdb-client~=1.36.1 | ||
| Requires-Dist: mysql-connector-python>=9.1.0 | ||
| Requires-Dist: psycopg2-binary~=2.9.6 | ||
| Requires-Dist: PyMySQL~=1.0.2 | ||
| Requires-Dist: PyYAML~=6.0 | ||
| Requires-Dist: requests~=2.28.1 | ||
| Requires-Dist: SQLAlchemy | ||
| Dynamic: author | ||
| Dynamic: author-email | ||
| Dynamic: classifier | ||
| Dynamic: description | ||
| Dynamic: description-content-type | ||
| Dynamic: home-page | ||
| Dynamic: keywords | ||
| Dynamic: license | ||
| Dynamic: license-file | ||
| Dynamic: requires-dist | ||
| Dynamic: requires-python | ||
| Dynamic: summary | ||
| <!-- | ||
| 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 |
-56
| <!-- | ||
| 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 |
-12
| [pycodestyle] | ||
| max_line_length = 88 | ||
| [flake8] | ||
| max_line_length = 88 | ||
| max_complexity = 10 | ||
| ignore = E203,W503,W292,W391,W503,W504 | ||
| [egg_info] | ||
| tag_build = | ||
| tag_date = 0 | ||
-59
| # SPDX-FileCopyrightText: 2017-2022 Contributors to the OpenSTEF project <korte.termijn.prognoses@alliander.com> # noqa E501> | ||
| # | ||
| # SPDX-License-Identifier: MPL-2.0 | ||
| from pathlib import Path | ||
| from setuptools import find_packages, setup | ||
| pkg_dir = Path(__file__).parent.absolute() | ||
| def read_requirements_from_file(): | ||
| with open(pkg_dir / "requirements.txt") as fh: | ||
| requirements = [] | ||
| for line in fh: | ||
| line = line.strip() | ||
| if "#" in line: | ||
| line = line[: line.index("#")].strip() | ||
| if len(line) == 0: | ||
| continue | ||
| requirements.append(line) | ||
| return requirements | ||
| def read_long_description_from_readme(): | ||
| with open("README.md", "r", encoding="utf-8") as fh: | ||
| return fh.read() | ||
| setup( | ||
| name="openstef_dbc", | ||
| version="3.8.6", | ||
| packages=find_packages(include=["openstef_dbc", "openstef_dbc.*"]), | ||
| description="Database Connection for OpenSTEF", | ||
| long_description=read_long_description_from_readme(), | ||
| long_description_content_type="text/markdown", | ||
| url="https://github.com/openstef/openstef-dbc", | ||
| author="Alliander N.V", | ||
| author_email="korte.termijn.prognoses@alliander.com", | ||
| license="MPL-2.0", | ||
| keywords=["database", "energy", "forecasting", "machinelearning"], | ||
| # See https://setuptools.readthedocs.io/en/latest/userguide/datafiles.html | ||
| # for more information | ||
| package_data={ | ||
| # Include anything in the data directory | ||
| "openstef_dbc": ["data/*", "*.license"] | ||
| }, | ||
| python_requires=">=3.12.0", | ||
| install_requires=read_requirements_from_file(), | ||
| setup_requires=["wheel", "Cython"], | ||
| tests_require=["pytest", "pytest-cov", "flake8"], | ||
| classifiers=[ | ||
| r"Development Status :: 5 - Production/Stable", | ||
| "Intended Audience :: Developers", | ||
| r"License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)", | ||
| "Programming Language :: Python :: 3.12", | ||
| "Programming Language :: Python :: 3.13", | ||
| ], | ||
| ) |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Worsened metrics
- Total package byte prevSize
0
-100%- Number of package files
0
-100%- Lines of code
0
-100%