pyoframe 0.1.4__tar.gz → 0.2.0__tar.gz

pyoframe-0.2.0/.gitattributes

@@ -0,0 +1,3 @@
+# This avoids the generated files from showing up in the stats. Note that I don't use 'linguist-generated' because I still want to see the diffs.
+# More info at: https://github.com/github-linguist/linguist/blob/main/docs/overrides.md
+/tests/examples/*/results/* linguist-documentation

pyoframe-0.2.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @staadecker

pyoframe-0.2.0/.github/actions/setup_optimizers_linux/action.yml

@@ -0,0 +1,132 @@
+# Copyright (c) 2023: Yue Yang
+# Mozilla Public License Version 2.0
+# https://mozilla.org/MPL/2.0/.
+
+name: "Install optimizers on linux"
+
+inputs:
+  GUROBI_WLS: 
+    description: "..."
+    required: true
+  # COPT_CLIENT_INI:
+  #   description: "..."
+  #   required: true
+  # MOSEK_LICENSE:
+  #   description: "..."
+  #   required: true
+  # GITHUB_TOKEN:
+  #   description: "..."
+  #   required: true
+  CHECK_LICENSE: 
+    description: "..."
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Create directory to store installers
+      shell: bash
+      run: |
+        mkdir -p ~/installers
+
+    - name: Cache Installers
+      id: cache-installers-linux
+      uses: actions/cache@v4
+      env:
+        cache-name: cache-installers-linux
+      with:
+        path: ~/installers
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('optimizer_version.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+
+    - if: ${{ steps.cache-installers-linux.outputs.cache-hit != 'true' }}
+      shell: bash
+      name: Download Installers
+      run: |
+        curl -L -o ~/installers/gurobi.tar.gz https://packages.gurobi.com/12.0/gurobi12.0.2_linux64.tar.gz
+
+    - name: Setup Gurobi Installation
+      shell: bash
+      env:
+        GUROBI_WLS: ${{ inputs.GUROBI_WLS }}
+      run: |
+        tar xfz ~/installers/gurobi.tar.gz -C ~/
+        ls ~/gurobi1202/linux64
+        # set environment variables
+        export GUROBI_HOME="${HOME}/gurobi1202/linux64"
+        echo "GUROBI_HOME=${GUROBI_HOME}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${GUROBI_HOME}/bin" >> $GITHUB_ENV
+        echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GUROBI_HOME}/lib" >> $GITHUB_ENV
+        echo $GUROBI_HOME
+        
+        # setup license using secrets
+        echo "$GUROBI_WLS" > ~/gurobi.lic
+        echo "GRB_LICENSE_FILE=${HOME}/gurobi.lic" >> $GITHUB_ENV
+    - name: Test Gurobi
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      uses: nick-fields/retry@v3    # wait 30 seconds (5x) if all licenses are already in use
+      with:
+        max_attempts: 5
+        retry_wait_seconds: 30
+        timeout_minutes: 1
+        command: gurobi_cl
+
+    # - name: Setup COPT Installation
+    #   shell: bash
+    #   env:
+    #     COPT_CLIENT_INI: ${{ inputs.COPT_CLIENT_INI }}
+    #   run: |
+    #     tar xfz ~/installers/copt.tar.gz -C ~/
+    #     ls ~/copt72
+    #     # set environment variables
+    #     export COPT_HOME="${HOME}/copt72"
+    #     echo "COPT_HOME=${COPT_HOME}" >> $GITHUB_ENV
+    #     echo "PATH=${PATH}:${COPT_HOME}/bin" >> $GITHUB_ENV
+    #     echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${COPT_HOME}/lib" >> $GITHUB_ENV
+    #     echo $COPT_HOME
+
+    #     # Just use the size-limited license
+    #     # echo "$COPT_CLIENT_INI" > ~/client.ini
+    #     # echo "COPT_LICENSE_DIR=${HOME}" >> $GITHUB_ENV
+    # - name: Test COPT
+    #   if: ${{ inputs.CHECK_LICENSE == 'true' }}
+    #   shell: bash
+    #   run: |
+    #     copt_cmd -c "quit"
+
+    # - name: Setup MOSEK Installation
+    #   shell: bash
+    #   env:
+    #     MOSEK_LICENSE: ${{ inputs.MOSEK_LICENSE }}
+    #   run: |
+    #     tar jxf ~/installers/mosek.tar.bz2 -C ~/
+    #     ls ~/mosek
+    #     # set environment variables
+    #     export MOSEK_10_2_BINDIR="${HOME}/mosek/10.2/tools/platform/linux64x86/bin"
+    #     echo "MOSEK_10_2_BINDIR=${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+    #     echo "PATH=${PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+    #     echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+    #     echo $MOSEK_10_2_BINDIR
+
+    #     # setup license using secrets
+    #     echo "$MOSEK_LICENSE" > ~/mosek.lic
+    #     echo "MOSEKLM_LICENSE_FILE=${HOME}/mosek.lic" >> $GITHUB_ENV
+    # - name: Test MOSEK
+    #   if: ${{ inputs.CHECK_LICENSE == 'true' }}
+    #   shell: bash
+    #   run: |
+    #     msktestlic
+
+    # - name: Setup IPOPT Installation
+    #   shell: bash
+    #   run: |
+    #     mkdir -p ~/ipopt
+    #     tar xfz ~/installers/idaes-solvers.tar.gz -C ~/ipopt
+    #     echo "PATH=${PATH}:${HOME}/ipopt" >> $GITHUB_ENV
+    #     echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${HOME}/ipopt" >> $GITHUB_ENV
+    #     ls ~/ipopt
+    # - name: Test IPOPT
+    #   shell: bash
+    #   run: |
+    #     ipopt -v

pyoframe-0.2.0/.github/actions/setup_optimizers_macos/action.yml

@@ -0,0 +1,175 @@
+# Copyright (c) 2023: Yue Yang
+# Mozilla Public License Version 2.0
+# https://mozilla.org/MPL/2.0/.
+
+name: "Install optimizers on macOS"
+
+inputs:
+  GUROBI_WLS: 
+    description: "..."
+    required: true
+  COPT_CLIENT_INI:
+    description: "..."
+    required: true
+  MOSEK_LICENSE:
+    description: "..."
+    required: true
+  GITHUB_TOKEN:
+    description: "..."
+    required: true
+  CHECK_LICENSE: 
+    description: "..."
+    required: true
+  ARCH:
+    description: "..."
+    required: true
+    type: choice
+    default: "X64"
+    options:
+      - "X64"
+      - "ARM64"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Create directory to store installers
+      shell: bash
+      run: |
+        mkdir -p ~/installers
+
+    - name: Cache Installers
+      id: cache-installers-macos
+      uses: actions/cache@v4
+      env:
+        cache-name: cache-installers-macos
+      with:
+        path: ~/installers
+        key: ${{ runner.os }}-${{ runner.arch }}-build-${{ env.cache-name }}-${{ hashFiles('optimizer_version.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ runner.arch }}-build-${{ env.cache-name }}-
+
+    - if: ${{ steps.cache-installers-macos.outputs.cache-hit != 'true' }}
+      shell: bash
+      name: Download Universal Installers
+      run: |
+        curl -L -o ~/installers/gurobi.pkg https://packages.gurobi.com/11.0/gurobi11.0.0_macos_universal2.pkg
+        curl -L -o ~/installers/copt.tar.gz https://pub.shanshu.ai/download/copt/7.2.2/osx64/CardinalOptimizer-7.2.2-universal_mac.tar.gz
+
+    - if: ${{ (steps.cache-installers-macos.outputs.cache-hit != 'true') && (inputs.ARCH == 'X64') }}
+      shell: bash
+      name: Download X64 Installers
+      run: |
+        curl -L -o ~/installers/mosek.tar.bz2 https://download.mosek.com/stable/10.2.0/mosektoolsosx64x86.tar.bz2
+        curl -L -o ~/installers/idaes-solvers.tar.gz https://github.com/IDAES/idaes-ext/releases/download/3.4.2/idaes-solvers-darwin-x86_64.tar.gz
+
+    - if: ${{ (steps.cache-installers-macos.outputs.cache-hit != 'true') && (inputs.ARCH == 'ARM64') }}
+      shell: bash
+      name: Download ARM64 Installers
+      run: |
+        curl -L -o ~/installers/mosek.tar.bz2 https://download.mosek.com/stable/10.2.0/mosektoolsosxaarch64.tar.bz2
+        curl -L -o ~/installers/idaes-solvers.tar.gz https://github.com/IDAES/idaes-ext/releases/download/3.4.2/idaes-solvers-darwin-aarch64.tar.gz
+
+    - name: Setup Gurobi Installation
+      shell: bash
+      env:
+        GUROBI_WLS: ${{ inputs.GUROBI_WLS }}
+      run: |
+        pkgutil --expand-full ~/installers/gurobi.pkg ~/gurobi
+        ls ~/gurobi
+        # set environment variables
+        export GUROBI_HOME="${HOME}/gurobi/gurobi11.0.0_macos_universal2.component.pkg/Payload/Library/gurobi1100/macos_universal2"
+        echo "GUROBI_HOME=${GUROBI_HOME}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${GUROBI_HOME}/bin" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${GUROBI_HOME}/lib" >> $GITHUB_ENV
+        echo $GUROBI_HOME
+        ls $GUROBI_HOME
+        
+        # setup license using secrets
+        echo "$GUROBI_WLS" > ~/gurobi.lic
+        echo "GRB_LICENSE_FILE=${HOME}/gurobi.lic" >> $GITHUB_ENV
+    - name: Test Gurobi
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      shell: bash
+      run: |
+        gurobi_cl
+
+    - name: Setup COPT Installation
+      shell: bash
+      env:
+        COPT_CLIENT_INI: ${{ inputs.COPT_CLIENT_INI }}
+      run: |
+        tar xfz ~/installers/copt.tar.gz -C ~/
+        ls ~/copt72
+        # set environment variables
+        export COPT_HOME="${HOME}/copt72"
+        echo "COPT_HOME=${COPT_HOME}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${COPT_HOME}/bin" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${COPT_HOME}/lib" >> $GITHUB_ENV
+        echo $COPT_HOME
+        ls $COPT_HOME
+
+        # Just use the size-limited license
+        # echo "$COPT_CLIENT_INI" > ~/client.ini
+        # echo "COPT_LICENSE_DIR=${HOME}" >> $GITHUB_ENV
+    - name: Test COPT
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      shell: bash
+      run: |
+        copt_cmd -c "quit"
+
+    - name: Setup MOSEK X64 Installation
+      if: ${{ inputs.ARCH == 'X64' }}
+      shell: bash
+      env:
+        MOSEK_LICENSE: ${{ inputs.MOSEK_LICENSE }}
+      run: |
+        tar jxf ~/installers/mosek.tar.bz2 -C ~/
+        ls ~/mosek/10.2/tools/platform
+        # set environment variables
+        export MOSEK_10_2_BINDIR="${HOME}/mosek/10.2/tools/platform/osx64x86/bin"
+        echo "MOSEK_10_2_BINDIR=${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo $MOSEK_10_2_BINDIR
+        ls $MOSEK_10_2_BINDIR
+
+        # setup license using secrets
+        echo "$MOSEK_LICENSE" > ~/mosek.lic
+        echo "MOSEKLM_LICENSE_FILE=${HOME}/mosek.lic" >> $GITHUB_ENV
+    - name: Setup MOSEK ARM64 Installation
+      if: ${{ inputs.ARCH == 'ARM64' }}
+      shell: bash
+      env:
+        MOSEK_LICENSE: ${{ inputs.MOSEK_LICENSE }}
+      run: |
+        tar jxf ~/installers/mosek.tar.bz2 -C ~/
+        ls ~/mosek/10.2/tools/platform
+        # set environment variables
+        export MOSEK_10_2_BINDIR="${HOME}/mosek/10.2/tools/platform/osxaarch64/bin"
+        echo "MOSEK_10_2_BINDIR=${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo "PATH=${PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${MOSEK_10_2_BINDIR}" >> $GITHUB_ENV
+        echo $MOSEK_10_2_BINDIR
+        ls $MOSEK_10_2_BINDIR
+
+        # setup license using secrets
+        echo "$MOSEK_LICENSE" > ~/mosek.lic
+        echo "MOSEKLM_LICENSE_FILE=${HOME}/mosek.lic" >> $GITHUB_ENV
+    - name: Test MOSEK
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      shell: bash
+      run: |
+        msktestlic
+
+    - name: Setup IPOPT Installation
+      shell: bash
+      run: |
+        mkdir -p ~/ipopt
+        tar xfz ~/installers/idaes-solvers.tar.gz -C ~/ipopt
+        echo "PATH=${PATH}:${HOME}/ipopt" >> $GITHUB_ENV
+        echo "DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:${HOME}/ipopt" >> $GITHUB_ENV
+        ls ~/ipopt
+    - name: Test IPOPT
+      shell: bash
+      run: |
+        ipopt -v

pyoframe-0.2.0/.github/actions/setup_optimizers_windows/action.yml

@@ -0,0 +1,137 @@
+# Copyright (c) 2023: Yue Yang
+# Mozilla Public License Version 2.0
+# https://mozilla.org/MPL/2.0/.
+
+name: "Install optimizers on windows"
+
+inputs:
+  GUROBI_WLS: 
+    description: "..."
+    required: true
+  # COPT_CLIENT_INI:
+  #   description: "..."
+  #   required: true
+  # MOSEK_LICENSE:
+  #   description: "..."
+  #   required: true
+  # GITHUB_TOKEN:
+  #   description: "..."
+  #   required: true
+  CHECK_LICENSE: 
+    description: "..."
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install lessmsi
+      shell: pwsh
+      run: |
+        curl -L -o D:\lessmsi.zip https://github.com/activescott/lessmsi/releases/download/v1.10.0/lessmsi-v1.10.0.zip
+        7z x D:\lessmsi.zip -oD:\lessmsi
+        echo "PATH=$env:PATH;D:\lessmsi" >> $env:GITHUB_ENV
+    - name: Test lessmsi
+      shell: pwsh
+      run: |
+        lessmsi h
+
+    - name: Create directory to store installers
+      shell: pwsh
+      run: |
+        New-Item -ItemType Directory -Force -Path "D:\installers"
+
+    - name: Cache Installers
+      id: cache-installers-windows
+      uses: actions/cache@v4
+      env:
+        cache-name: cache-installers-windows
+      with:
+        path: D:\installers
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('optimizer_version.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+
+    - if: ${{ steps.cache-installers-windows.outputs.cache-hit != 'true' }}
+      shell: pwsh
+      name: Download Installers
+      run: |
+        curl -L -o D:\installers\gurobi.msi https://packages.gurobi.com/11.0/Gurobi-11.0.0-win64.msi
+        
+    - name: Setup Gurobi Installation
+      shell: pwsh
+      env:
+        GUROBI_WLS: ${{ inputs.GUROBI_WLS }}
+      run: |
+        lessmsi x D:\installers\gurobi.msi "D:\" gurobi_cl.exe
+        lessmsi x D:\installers\gurobi.msi "D:\" gurobi110.dll gurobi110.lib
+        lessmsi x D:\installers\gurobi.msi "D:\" gurobi_c.h
+        ls D:\SourceDir\gurobi1100\win64
+        # set environment variables
+        echo "GUROBI_HOME=D:\SourceDir\gurobi1100\win64" >> $env:GITHUB_ENV
+        echo "PATH=$env:PATH;D:\SourceDir\gurobi1100\win64\bin" >> $env:GITHUB_ENV
+        echo $env:GUROBI_HOME
+        
+        # setup license using secrets
+        echo $env:GUROBI_WLS > D:\gurobi.lic
+        echo "GRB_LICENSE_FILE=D:\gurobi.lic" >> $env:GITHUB_ENV
+    - name: Test Gurobi
+      if: ${{ inputs.CHECK_LICENSE == 'true' }}
+      shell: pwsh
+      run: |
+        gurobi_cl
+
+    # - name: Setup COPT Installation
+    #   shell: pwsh
+    #   env:
+    #     COPT_CLIENT_INI: ${{ inputs.COPT_CLIENT_INI }}
+    #   run: |
+    #     # unzip with 7zip
+    #     7z x D:\installers\copt.zip -oD:\
+    #     ls D:\copt72
+    #     # set environment variables
+    #     echo "COPT_HOME=D:\copt72" >> $env:GITHUB_ENV
+    #     echo "PATH=$env:PATH;D:\copt72\bin" >> $env:GITHUB_ENV
+    #     echo $env:COPT_HOME
+
+    #     # Just use the size-limited license
+    #     # echo $env:COPT_CLIENT_INI > D:\client.ini
+    #     # echo "COPT_LICENSE_DIR=D:\" >> $env:GITHUB_ENV
+    # - name: Test COPT
+    #   if: ${{ inputs.CHECK_LICENSE == 'true' }}
+    #   shell: pwsh
+    #   run: |
+    #     copt_cmd -c "quit"
+
+    # - name: Setup MOSEK Installation
+    #   shell: pwsh
+    #   env:
+    #     MOSEK_LICENSE: ${{ inputs.MOSEK_LICENSE }}
+    #   run: |
+    #     lessmsi x D:\installers\mosek.msi "D:\" msktestlic.exe
+    #     lessmsi x D:\installers\mosek.msi "D:\" mosek64_10_2.dll mosek64_10_2.lib tbb12.dll svml_dispmd.dll
+    #     lessmsi x D:\installers\mosek.msi "D:\" mosek.h
+    #     ls D:\SourceDir\PFiles\Mosek\10.2\tools\platform\win64x86
+    #     # set environment variables
+    #     echo "MOSEK_10_2_BINDIR=D:\SourceDir\PFiles\Mosek\10.2\tools\platform\win64x86\bin" >> $env:GITHUB_ENV
+    #     echo "PATH=$env:PATH;D:\SourceDir\PFiles\Mosek\10.2\tools\platform\win64x86\bin" >> $env:GITHUB_ENV
+    #     echo $env:MOSEK_10_2_BINDIR
+
+    #     # setup license using secrets
+    #     echo $env:MOSEK_LICENSE > D:\mosek.lic
+    #     echo "MOSEKLM_LICENSE_FILE=D:\mosek.lic" >> $env:GITHUB_ENV
+    # - name: Test MOSEK
+    #   if: ${{ inputs.CHECK_LICENSE == 'true' }}
+    #   shell: pwsh
+    #   run: |
+    #     msktestlic
+
+    # - name: Setup IPOPT solver
+    #   shell: pwsh
+    #   run: |
+    #     7z x -so D:\installers\idaes-solvers.tar.gz | 7z x -si -ttar -oD:\ipopt
+    #     echo "PATH=D:\ipopt;$env:PATH" >> $env:GITHUB_ENV
+    #     ls D:\ipopt
+    # - name: Test IPOPT
+    #   shell: pwsh
+    #   run: |
+    #     ipopt -v

pyoframe-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,94 @@
+# Note: We use the insecure pull_request_target to allow running workflows from forks.
+# However, we've added checks (see below) for safety.
+# In short, the 'safe to test' label must exist AND the workflow must be run by someone with write access.
+# See more details here:
+#   - https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/
+#   - https://michaelheap.com/access-secrets-from-forks/
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+  pull_request_target:
+    branches: ["*"]
+  schedule:
+    - cron: "0 5 * * WED"
+  workflow_dispatch:
+
+jobs:
+  check_permissions:
+    runs-on: ubuntu-latest
+    steps:
+      # Important checks to ensure that the user has the required permissions. See note above.
+      # Step 1: If user has current permissions we're good!
+      - name: Get User Permission
+        id: checkAccess
+        uses: actions-cool/check-user-permission@v2
+        with:
+          require: write
+          username: ${{ github.actor }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Otherwise, get triggering user's permissions
+      - name: Get Triggering User Permission
+        if: steps.checkAccess.outputs.require-result == 'false'
+        id: checkTriggeringAccess
+        uses: actions-cool/check-user-permission@v2
+        with:
+          require: write
+          username: ${{ github.triggering_actor }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # If neither has permissions and no 'safe to test' label throw error
+      - name: Check User Permission
+        if: steps.checkAccess.outputs.require-result == 'false' && steps.checkTriggeringAccess.outputs.require-result == 'false' && !contains(github.event.pull_request.labels.*.name, 'safe to test')
+        shell: bash
+        run: |
+          echo "${{ github.triggering_actor }} does not have permissions on this repo."
+          echo "Re-run the test yourself if you have write permissions. Alternatively, add the label 'safe to test' to the PR to give the user write permissions (only if you trust them)."
+          exit 1
+  run:
+    if: |
+      (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository) || 
+      (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.full_name != github.repository) || 
+      (github.event_name != 'pull_request_target' && github.event_name != 'pull_request')
+    runs-on: ubuntu-latest
+    needs: check_permissions
+    continue-on-error: ${{ !matrix.latest }}
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.13"]
+        latest: [true]
+        include:
+          - python-version: "3.9"
+            latest: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.ref }}
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+      - uses: ./.github/actions/setup_optimizers_linux
+        with:
+          GUROBI_WLS: ${{ secrets.GUROBI_WLS }}
+          CHECK_LICENSE: true
+      - name: Install dependencies
+        run: |
+          pip install --editable .[dev]
+      - name: Run tests and collect coverage
+        run: pytest --cov
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4-beta
+        with:
+          name: coverage-python-${{ matrix.python-version }}
+          flags: smart-tests
+          verbose: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

pyoframe-0.2.0/.github/workflows/format.yml

@@ -0,0 +1,16 @@
+name: Check formatting with Ruff
+
+on: [pull_request]
+
+env:
+  INPUT_JUPYTER: true
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check --diff"
+      

pyoframe-0.2.0/.github/workflows/lines_changed_counter.yml

@@ -0,0 +1,49 @@
+# MIT License
+# Copyright (c) 2021 Viacheslav Poturaev
+name: Comment on PR with lines changed
+on:
+  pull_request:
+
+# Cancel the workflow in progress in newer build is about to start.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  line-count:
+    runs-on: ubuntu-latest
+
+    permissions:
+        pull-requests: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          path: pr
+      - name: Checkout base code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+      - name: Count Lines Of Code
+        id: loc
+        run: |
+          curl -sLO https://github.com/vearutop/sccdiff/releases/download/v1.0.3/linux_amd64.tar.gz && tar xf linux_amd64.tar.gz
+          sccdiff_hash=$(git hash-object ./sccdiff)
+          [ "$sccdiff_hash" == "ae8a07b687bd3dba60861584efe724351aa7ff63" ] || (echo "::error::unexpected hash for sccdiff, possible tampering: $sccdiff_hash" && exit 1)
+          OUTPUT=$(cd pr && ../sccdiff -basedir ../base)
+          echo "${OUTPUT}"
+          OUTPUT="${OUTPUT//$'\n'/%0A}"
+          echo "::set-output name=diff::$OUTPUT"
+
+      - name: Comment Code Lines
+        continue-on-error: true
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          header: LOC
+          message: |
+            ### Lines Of Code
+
+            ${{ steps.loc.outputs.diff }}

pyoframe-0.2.0/.github/workflows/lint.yml

@@ -0,0 +1,13 @@
+name: Check linting with Ruff
+on: [pull_request]
+
+env:
+  INPUT_JUPYTER: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3  # Default is linter
+      

pyoframe-0.2.0/.github/workflows/publish_doc.yml

@@ -0,0 +1,33 @@
+name: Docs
+on:
+  release:
+    types: [published]
+env:
+  ENABLED_GIT_REVISION_DATE: true
+  ENABLED_GIT_COMMITTERS: true
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for git-revision-date-localized plugin
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+          cache: 'pip'
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install .[docs]
+      - run: mkdocs gh-deploy --force