openstef 3.4.93.dev0__tar.gz → 4.0.0__tar.gz

openstef-4.0.0/.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+# Require review from maintainers for CI/CD workflow changes
+.github/workflows/ @OpenSTEF/openstef-maintainers
+.github/CODEOWNERS @OpenSTEF/openstef-maintainers

openstef-4.0.0/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,72 @@
+<!--
+SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+*   Using welcoming and inclusive language
+*   Being respectful of differing viewpoints and experiences
+*   Gracefully accepting constructive criticism
+*   Focusing on what is best for the community
+*   Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+*   The use of sexualized language or imagery and unwelcome sexual attention or
+    advances
+*   Trolling, insulting/derogatory comments, and personal or political attacks
+*   Public or private harassment
+*   Publishing others' private information, such as a physical or electronic
+    address, without explicit permission
+*   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+
+## Conflict Resolution
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at openstef@lfenergy.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
+available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

openstef-4.0.0/.github/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+<!--
+SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
+# Contributing to OpenSTEF
+
+Thank you for your interest in contributing to OpenSTEF! 🚀
+
+## Quick Start
+
+1. **Read our contributing guide**: [openstef.github.io/openstef/contribute](https://openstef.github.io/openstef/contribute/index.html)
+2. **Install dependencies**: `uv sync --group dev`
+3. **Make your changes** and ensure all checks pass: `uv run poe all --check`
+4. **Submit a pull request**
+
+## Documentation
+
+For information about:
+
+- 🛠️ **Development setup** - Environment setup with uv and modern Python tools
+- 🔄 **Development workflow** - Branch naming, commit messages, and PR process  
+- 📝 **Documentation guidelines** - Writing docs and examples
+- 🧪 **Testing standards** - Writing and running tests
+- 📋 **Style guide** - Code formatting and quality standards
+
+**Visit our full contributing guide: [openstef.github.io/openstef/contribute](https://openstef.github.io/openstef/contribute/index.html)**
+
+## Getting Help
+
+- 💬 **Slack**: [LF Energy workspace](https://slack.lfenergy.org/) (#openstef channel)
+- 🐛 **Issues**: [GitHub Issues](https://github.com/OpenSTEF/openstef/issues)
+- 📧 **Email**: openstef@lfenergy.org
+- 📖 **Support**: [Support page](https://openstef.github.io/openstef/project/support.html)
+
+## Good First Issues
+
+New contributors should look for [`good first issue`](https://github.com/OpenSTEF/openstef/labels/good%20first%20issue) labels!

openstef-4.0.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+
+**Additional context**
+Add any other context about the problem here.

openstef-4.0.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

openstef-4.0.0/.github/ISSUE_TEMPLATE/openstef-4-0-project-story.md

@@ -0,0 +1,47 @@
+---
+name: OpenSTEF 4.0 Project Story
+about: Describe this issue template's purpose here.
+title: "[OpenSTEF 4.0] "
+labels: OpenSTEF 4.0
+assignees: ''
+
+---
+
+As
+I want to 
+So that I
+
+🌍 Background
+
+> [!IMPORTANT]
+> Changes should be done by forking [OpenSTEF 4.0.0 tracking branch](https://github.com/OpenSTEF/openstef/tree/release/v4.0.0) (`release/v4.0.0`) and then make a PR back onto `release/v4.0.0` branch.
+> Please read the [contributing guide](https://openstef.github.io/openstef/v4/contribute/index.html) before you start.
+
+❗Priority (What if we don't do this?/Are there any deadlines? etc.)
+
+Definition of Done:
+
+✅ Acceptance criteria
+
+- [ ] 
+
+📄 Documentation criteria:
+
+Interfaces with other products and services
+
+Update relevant confluence pages
+
+🧪 Test criteria:
+
+Unit tests written and passed
+
+⌛ Dependencies:
+
+N/A
+
+🚀 Releasing:
+
+N/A
+
+Other information:
+

openstef-4.0.0/.github/pr-labeler.yml

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+# config of action in ./workflows/...
+feature: ['feature*', 'feat*']
+fix: ['fix*','bugfix*','hotfix*', 'bug*']
+chore: ['chore*', 'doc*']

openstef-4.0.0/.github/workflows/_job_quality_check.yaml

@@ -0,0 +1,68 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Quality Check
+on:
+  workflow_call:
+    inputs:
+      # _SKIP*: sometimes you want to quickly test something, without having the whole suite kicking in.
+      # This is a lazy way to switch on and off steps. But never set it to true in main.
+      _SKIP_QUALITY:
+        type: boolean
+        default: false
+        description: for debug purposes only - if true skip all quality checks.
+
+jobs:
+  builder:
+    name: Quality Checks
+    # Avoid duplicate runs: run on push (same-repo branches) OR on pull_request only if from a fork
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout # Must be done before using composite actions
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          show-progress: false # very verbose for not much
+      - name: Install uv
+        uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        # uv is needed for qa and deploy, so is kinda always needed. No need to skip it.
+        with:
+          activate-environment: true
+          enable-cache: true
+      - name: Install dependencies
+        if: ${{ always() }}
+        run: uv sync --frozen --no-install-project --all-groups --all-extras --all-packages
+
+      # Run quality checks
+      - name: reuse
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe reuse
+      - name: licensecheck
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe licensecheck --check
+      - name: lint
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe lint --check
+      - name: format
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe format --check
+      - name: format-pyproject
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe format-pyproject --check
+      - name: typing
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe type
+      - name: tests
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe tests
+      - name: doctests
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe doctests
+      - name: notebooks-check
+        if: ${{ ! inputs._SKIP_QUALITY && always() }}
+        run: poe notebooks-check
+
+      - name: Stop if any quality step failed
+        # All tests are run with always() not to stop on the first error. This step makes the workflow fail if any quality step failed.
+        if: ${{ failure() }}
+        run: exit 1

openstef-4.0.0/.github/workflows/check.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+name: Quality Check
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Quality Checks
+    uses: ./.github/workflows/_job_quality_check.yaml

openstef-4.0.0/.github/workflows/citations.yaml

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2017-2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Validate citation
+
+on:
+  # Run pipeline on push event of main branch, or when CITATIONS path has changed
+  push:
+    branches:
+      - main
+    paths:
+      - CITATION.cff
+      - .github/workflows/citations.yml
+  pull_request:
+    paths:
+      - CITATION.cff
+      - .github/workflows/citations.yml
+  # Run pipeline from another workflow
+  workflow_call:
+  # Run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-citations
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  validate-citations:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: checkout
+      uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+    - name: Install R
+      run: |
+        sudo apt-get update && sudo apt-get install -y r-base
+    - name: Validate CITATION.cff
+      uses: dieghernan/cff-validator@114aae53e1850c3757733beb60036941900e3dc3 # v4

openstef-4.0.0/.github/workflows/docs.yaml

@@ -0,0 +1,89 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy-docs:
+    name: Build and Deploy Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          show-progress: false
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        with:
+          activate-environment: true
+          enable-cache: true
+      
+      - name: Install dependencies
+        run: uv sync --frozen --no-install-project --all-groups --all-extras
+      
+      - name: Build Sphinx documentation
+        run: poe docs
+      
+      - name: Checkout gh-pages branch for deployment
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          ref: gh-pages
+          path: gh-pages-repo
+          show-progress: false
+      
+      - name: Update documentation
+        run: |
+          # One-shot: archive the existing v3 site into /v3/ if not already done.
+          # Detected by absence of /v3/ and presence of index.html at the root.
+          if [ ! -d gh-pages-repo/v3 ] && [ -f gh-pages-repo/index.html ]; then
+            echo "Archiving existing v3 documentation to gh-pages-repo/v3/"
+            mkdir -p gh-pages-repo/v3
+            find gh-pages-repo -maxdepth 1 -mindepth 1 \
+              ! -name v3 ! -name v4 ! -name .git ! -name .nojekyll \
+              -exec mv {} gh-pages-repo/v3/ \;
+          fi
+
+          # Clear root (but preserve /v3/, /v4/, .git, .nojekyll) and deploy.
+          find gh-pages-repo -maxdepth 1 -mindepth 1 \
+            ! -name v3 ! -name v4 ! -name .git ! -name .nojekyll \
+            -exec rm -rf {} +
+          cp -r docs/build/html/. gh-pages-repo/
+
+      - name: Configure git, stage, and commit changes
+        run: |
+            cd gh-pages-repo
+
+            # Configure git
+            git config --local user.email "action@github.com"
+            git config --local user.name "GitHub Action"
+
+            # Stage changes
+            git add -A
+
+            # Check if there are staged changes and commit if so
+            if ! git diff --staged --quiet; then
+                git commit -m "Deploy documentation from $(echo $GITHUB_SHA | cut -c1-7)"
+                echo "✅ Changes committed successfully"
+            else
+                echo "ℹ️ No changes to commit"
+            fi
+      
+      - name: Push changes to gh-pages
+        uses: ad-m/github-push-action@77c5b412c50b723d2a4fbc6d71fb5723bcd439aa # v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          directory: gh-pages-repo

openstef-4.0.0/.github/workflows/pr-labeler.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2017-2022 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+#
+# SPDX-License-Identifier: MPL-2.0
+# Automatically label PRs, config in ../pr-labler.yml
+name: PR Labeler
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  pr-labeler:
+    permissions:
+        contents: read # To read config file
+        pull-requests: write # To add labels
+    runs-on: ubuntu-latest
+    steps:
+      - uses: TimonVS/pr-labeler-action@f9c084306ce8b3f488a8f3ee1ccedc6da131d1af # v5
+        with:
+          configuration-path: .github/pr-labeler.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

openstef-4.0.0/.github/workflows/release-dev.yaml

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+name: Dev Release
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: ['main']
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    name: Quality Checks
+    uses: ./.github/workflows/_job_quality_check.yaml
+
+  deploy-dev:
+    name: Release Dev Version
+    needs: quality
+    runs-on: ubuntu-latest
+    if: ${{ needs.quality.result == 'success' }}
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          fetch-depth: 0
+          show-progress: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        with:
+          activate-environment: true
+          enable-cache: true
+      - name: Install build dependencies
+        run: uv sync --frozen --no-install-project --all-groups --all-extras
+
+      # Start of release steps
+      - name: Compute ephemeral dev version
+        id: ver
+        run: |
+          set -euo pipefail
+          BASE_VERSION="4.0.0"
+          TS=$(date -u +%Y%m%d%H%M)
+          HASH=$(git rev-parse --short=8 HEAD)
+          VERSION="${BASE_VERSION}.dev${TS}+g${HASH}"
+          echo "Computed version: $VERSION"
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+      - name: Apply version
+        run: poe version --version '${{ steps.ver.outputs.version }}'
+      - name: Build all packages
+        run: poe build
+      - name: Publish packages
+        if: false # Set to true once mvp is ready.
+        env:
+          UV_PUBLISH_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          UV_PUBLISH_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: uv publish
+      - name: Summary
+        run: echo "Published version ${{ steps.ver.outputs.version }}"

openstef-4.0.0/.github/workflows/release-v4.yaml

@@ -0,0 +1,83 @@
+# SPDX-FileCopyrightText: 2025 Contributors to the OpenSTEF project <openstef@lfenergy.org>
+# SPDX-License-Identifier: MPL-2.0
+
+name: Release V4
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version tag to release (e.g., v4.1.0 or 4.1.0). Prefixing with v is optional.'
+        required: true
+        default: ""
+
+permissions:
+  contents: read
+
+jobs:
+  quality:
+    if: ${{ startsWith(github.ref, 'refs/tags/v4.') || (github.event_name == 'workflow_dispatch' && startsWith(github.event.inputs.version, 'v4')) }}
+    name: Quality Checks
+    uses: ./.github/workflows/_job_quality_check.yaml
+
+  release-pypi:
+    name: Release PyPI Package
+    needs: quality
+    runs-on: ubuntu-latest
+    environment: release
+    if: ${{ (startsWith(github.ref, 'refs/tags/v4.') || (github.event_name == 'workflow_dispatch' && startsWith(github.event.inputs.version, 'v4'))) && needs.quality.result == 'success' }}
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
+        with:
+          fetch-depth: 0
+          show-progress: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@d0d8abe699bfb85fec6de9f7adb5ae17292296ff # v6
+        with:
+          activate-environment: true
+          enable-cache: true
+      - name: Install build dependencies
+        run: uv sync --frozen --no-install-project --all-groups --all-extras
+
+      # Start of release steps
+      - name: Set version from release
+        id: ver
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+          INPUT_VERSION: ${{ github.event.inputs.version }}
+        run: |
+          # Prefer release payload tag_name, otherwise fallback to the workflow_dispatch input
+          if [ -n "$RELEASE_TAG" ]; then
+            VERSION="$RELEASE_TAG"
+          elif [ -n "$INPUT_VERSION" ]; then
+            VERSION="$INPUT_VERSION"
+          else
+            # As a last-resort fallback, try to get the ref tag from GITHUB_REF
+            if [[ "$GITHUB_REF" == refs/tags/* ]]; then
+              VERSION="${GITHUB_REF#refs/tags/}"
+            else
+              echo "No version provided via release or workflow input, aborting"
+              exit 1
+            fi
+          fi
+          # Remove leading 'v' if present
+          VERSION="${VERSION#v}"
+          echo "Release version: $VERSION"
+          echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
+      - name: Apply version
+        run: poe version --version "${{ steps.ver.outputs.version }}"
+      - name: Build all packages
+        run: poe build
+      - name: Publish packages
+        run: uv publish --trusted-publishing always
+      - name: Summary
+        run: echo "Published version ${{ steps.ver.outputs.version }}"