Merge branch 'develop' into feature/1931-update-the-opr-to-use-oemtadata-v2-specification

Author: Darynarli

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.3.0
+current_version = 1.3.2
 
 [bumpversion:file:VERSION]
 

.github/workflows/reuse.yml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2025 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut
+# SPDX-FileCopyrightText: oeplatform <https://github.com/OpenEnergyPlatform/oeplatform>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+name: 📝 REUSE Compliance Check
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: REUSE compliance check
+        uses: fsfe/reuse-action@v4

CITATION.cff

@@ -1,4 +1,4 @@
-cff-version: 1.3.0
+cff-version: 1.3.2
 message: "If you use this software, please cite it using these metadata."
 authors:
   - family-names: "Hülk"
@@ -28,7 +28,7 @@ authors:
 title: "Open Energy Family - Open Energy Platform (OEP)"
 type: software
 license: AGPL-3.0-or-later
-version: 1.3.0
+version: 1.3.2
 doi:
-date-released: 2025-06-11
+date-released: 2025-07-10
 url: "https://github.com/OpenEnergyPlatform/oeplatform/"

README.md

@@ -0,0 +1,117 @@
+..
+  SPDX-FileCopyrightText: oeplatform <https://github.com/OpenEnergyPlatform/oeplatform>
+  SPDX-License-Identifier: CC0-1.0
+
+.. figure:: https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/docs/img/banner_oefamily_oep.png
+    :align: left
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/
+    :alt: OEP Logo
+
+==========================
+Open Energy Platform (OEP)
+==========================
+
+**The Open Energy Platform (OEP) is research data infrastructure for the energy, climate and mobility domain.**
+
+.. list-table::
+   :widths: auto
+
+   * - License
+     - |badge_license| |badge_reuse|
+   * - Documentation
+     - |badge_documentation| |badge_mkdocs|
+   * - Tests
+     - |badge_tox|
+   * - Publication
+     -
+   * - Development
+     - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
+   * - Community
+     - |badge_contributions| |badge_contributors| |badge_repo_counts|
+
+.. contents::
+    :depth: 2
+    :local:
+    :backlinks: top
+
+Introduction
+============
+| The Open Energy Family promotes quality, transparency, and reproducibility in energy system research through a collection of tools.
+| The primary module, the Open Energy Platform (OEP), offers a web interface for accessing various tools and the community database.
+
+
+Documentation
+=============
+| The documentation is created with Markdown using `MkDocs <https://www.mkdocs.org/>`_ and `mike <https://github.com/jimporter/mike>`_.
+| All files are stored in the ``docs`` folder of the repository.
+| A **GitHub Actions** deploys the ``develop`` branch on a **GitHub Page**.
+| The documentation page is: `openenergyplatform.github.io/oeplatform/ <https://openenergyplatform.github.io/oeplatform/>`_
+
+Collaboration
+=============
+| Everyone is invited to develop this repository with good intentions.
+| Please follow the workflow described in the `CONTRIBUTING.md <https://github.com/OpenEnergyPlatform/oeplatform/blob/master/CONTRIBUTING.md>`_.
+
+Contributors:
+
+.. figure:: https://contrib.rocks/image?repo=OpenEnergyPlatform/oeplatform
+    :align: left
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/graphs/contributors
+    :alt: [contrib.rocks](https://contrib.rocks)
+
+License and Citation
+====================
+| The code of this repository is licensed under the **GNU Affero General Public License v3.0 or later** (AGPL-3.0-or-later).
+| Authorship and license for each file are documented using `REUSE <https://api.reuse.software/info/github.com/OpenEnergyPlatform/oeplatform>`_ specification.
+| See `LICENSE.txt <https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/LICENSE.txt>`_ for rights and obligations.
+| See the *Cite this repository* function or `CITATION.cff <https://github.com/OpenEnergyPlatform/oeplatform/blob/master/CITATION.cff>`_ for citation of this repository.
+| Copyright: `oeplatform <https://github.com/OpenEnergyPlatform/oeplatform/>`_ © OEP-Developers | `AGPL-3.0-or-later <LICENSE.txt>`_
+
+
+.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/LICENSE.txt
+    :alt: License
+
+.. |badge_reuse| image:: https://api.reuse.software/badge/github.com/OpenEnergyPlatform/oeplatform
+    :target: https://api.reuse.software/info/github.com/OpenEnergyPlatform/oeplatform
+    :alt: REUSE
+
+.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oeplatform/deploy-docs.yaml?branch=develop&label=documentation
+    :target: https://openenergyplatform.github.io/oeplatform/
+    :alt: Documentation
+
+.. |badge_mkdocs| image:: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=flat&logo=MaterialForMkDocs&logoColor=white&color=grey
+    :target: https://squidfunk.github.io/mkdocs-material/
+    :alt: MkDocs
+
+.. |badge_tox| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oeplatform/automated-testing.yaml?label=tox
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/actions/workflows/automated-testing.yaml
+    :alt: Tox Tests
+
+.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/issues
+    :alt: Open Issues
+
+.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/issues?q=is%3Aissue+is%3Aclosed
+    :alt: Closed Issues
+
+.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/pulls
+    :alt: Open PR
+
+.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/pulls?q=is%3Apr+is%3Aclosed
+    :alt: Closed PR
+
+.. |badge_contributions| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/blob/master/CONTRIBUTING.md
+    :alt: Contributions
+
+.. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/oeplatform
+    :target: https://github.com/OpenEnergyPlatform/oeplatform/graphs/contributors
+    :alt: Contributors
+
+.. |badge_repo_counts| image:: https://hits.sh/github.com/OpenEnergyPlatform/oeplatform.svg
+    :target: https://hits.sh/github.com/OpenEnergyPlatform/oeplatform/
+    :alt: Hits

README.rst

@@ -261,6 +261,14 @@ SPDX-FileCopyrightText = [
   "2023 Jonas Huber <https://github.com/jh-RLI> © Reiner Lemoine Institut",
 ]
 
+[[annotations]]
+path = "docs/img/banner_oefamily_oep.png"
+precedence = "override"
+SPDX-License-Identifier = [ "CC-BY-4.0",]
+SPDX-FileCopyrightText = [
+  "2025 Ludwig Hülk <https://github.com/Ludee> © Reiner Lemoine Institut",
+]
+
 [[annotations]]
 path = "docs/oeplatform-code/web-api/oekg-api/oekg.yaml"
 precedence = "override"
@@ -3295,6 +3303,14 @@ SPDX-FileCopyrightText = [
   "2025 Jonas Huber <https://github.com/jh-RLI> © Reiner Lemoine Institut",
 ]
 
+[[annotations]]
+path = "dataedit/management/data/**"
+precedence = "override"
+SPDX-License-Identifier = "CC0-1.0"
+SPDX-FileCopyrightText = [
+  "2025 Jonas Huber <https://github.com/jh-RLI> © Reiner Lemoine Institut",
+]
+
 [[annotations]]
 path = "dataedit/static/database/css/database-enhancements.css"
 precedence = "override"

REUSE.toml

@@ -1 +1 @@
-1.3.0
+1.3.2

VERSION

@@ -191,10 +191,20 @@ <h1 class="main-header__title">
           Metadata specification
         </a>
       </span>
-      <button onclick="downloadMetadata();" data-bs-toggle="tooltip" title="Download metadata in JSON format"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-download me-2" viewBox="0 0 16 16">
-        <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5z"/>
-        <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3z"/>
-      </svg>Download JSON</button>
+      <div class="dropdown">
+        <button class="btn btn-secondary dropdown-toggle" type="button" id="metadataDropdown" data-bs-toggle="dropdown" aria-expanded="false" title="Download or view metadata">
+          <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-download me-2" viewBox="0 0 16 16">
+            <path d="M.5 9.9a.5.5 0 0 1 .5.5v2.5a1 1 0 0 0 1 1h12a1 1 0 0 0 1-1v-2.5a.5.5 0 0 1 1 0v2.5a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2v-2.5a.5.5 0 0 1 .5-.5z"/>
+            <path d="M7.646 11.854a.5.5 0 0 0 .708 0l3-3a.5.5 0 0 0-.708-.708L8.5 10.293V1.5a.5.5 0 0 0-1 0v8.793L5.354 8.146a.5.5 0 1 0-.708.708l3 3z"/>
+          </svg>
+          Metadata Options
+        </button>
+        <ul class="dropdown-menu" aria-labelledby="metadataDropdown">
+          <li><a class="dropdown-item" href="#" onclick="downloadMetadata(); return false;">Download JSON</a></li>
+          <li><a class="dropdown-item" href="#" onclick="openMetadataApiPage(); return false;">Open Metadata API Page</a></li>
+        </ul>
+      </div>
+
 
       <span {% if not can_add or opr.opr_id and not opr.is_finished %} data-bs-toggle="tooltip" title="You need write permissions on this table to edit metadata. If you have permissions it is likely that a metadata review is in progress, data can't be changed during ongoing Open Peer Reviews." {% endif %}>
     <a href="{{table}}/meta_edit" type="button" class="btn btn-primary btn-sm {% if not can_add or opr.opr_id and not opr.is_finished %} disabled {% endif %}">
@@ -549,6 +559,11 @@ <h2 class="table-sidebar__heading">API Usage</h2>
     })
   };
 
+  var openMetadataApiPage = function () {
+    var metaUrl = "/api/v0/schema/{{ schema }}/tables/{{ table }}/meta";
+    window.open(metaUrl, "_blank");
+  };
+
   DataEdit(table=table, schema=schema);
 
   $(function () {