vgf-adapter-model-explorer 0.5.0__tar.gz

vgf_adapter_model_explorer-0.5.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @arm/arm-model-explorer

vgf_adapter_model_explorer-0.5.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug Report
+about: Report issue (excl. security; see SECURITY.md)
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Bug Description
+<!-- Provide a clear and concise description of the bug -->
+
+## Steps to Reproduce
+1. 
+2. 
+3. 
+<!-- Add more steps as needed -->
+
+## Expected Behavior
+<!-- Describe what you expected to happen -->
+
+## Actual Behavior
+<!-- Describe what actually happened -->
+
+## Screenshots
+<!-- If applicable, add screenshots to help explain your problem -->
+
+## Environment
+<!-- Add any other relevant environment details -->
+- Model Explorer Version: [e.g., 1.2.3]
+- Adapter Version: [e.g., 1.2.3]
+- OS: [e.g., Windows 10, macOS 12.0]
+
+## Additional Context
+<!-- Add any other context about the problem here -->
+
+## Possible Solution (Optional)
+<!-- If you have suggestions on how to fix the bug, add them here -->
+
+## Logs/Error Messages
+<!-- Include any relevant log entries or error messages -->
+
+- [ ] I have searched for existing bug reports
+- [ ] I have included all relevant information

vgf_adapter_model_explorer-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+
+blank_issues_enabled: false

vgf_adapter_model_explorer-0.5.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Suggest a new feature or enhancement
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Feature Description
+<!-- Provide a clear and concise description of the feature you'd like to see implemented -->
+
+## Problem Statement
+<!-- Describe the problem this feature would solve or the need it addresses -->
+
+## Proposed Solution
+<!-- Describe how you envision this feature working -->
+
+## Alternative Solutions
+<!-- Describe any alternative solutions or features you've considered -->
+
+## Additional Context
+<!-- Add any other context, screenshots, or examples about the feature request here -->
+
+- [ ] I have searched for existing feature requests

vgf_adapter_model_explorer-0.5.0/.github/actions/build-wheel/action.yml

@@ -0,0 +1,89 @@
+name: Build wheel (composite)
+description: Builds wheels for VGF Adapter for Model Explorer
+
+inputs:
+  python-version:
+    required: true
+  internal-dev-version:
+    required: false
+    default: "false"
+  artifact-name:
+    required: false
+    default: dist
+  build-sdist:
+    required: false
+    default: "false"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python environment
+      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Ensure pip is available
+      shell: bash
+      run: |
+        python -m ensurepip --upgrade || {
+          curl -sS https://bootstrap.pypa.io/get-pip.py -o "$RUNNER_TEMP/get-pip.py"
+          python "$RUNNER_TEMP/get-pip.py"
+        }
+        python -m pip install --upgrade pip
+
+    - name: Set internal development version
+      if: inputs.internal-dev-version == 'true'
+      shell: bash
+      run: |
+        BASE_VERSION=$(sed -n 's/^version = "\(.*\)"$/\1/p' pyproject.toml | head -n 1)
+        SHORT_SHA="${GITHUB_SHA::7}"
+        DEV_VERSION="${BASE_VERSION}.dev${GITHUB_RUN_NUMBER}+${SHORT_SHA}"
+        echo "Building internal development version ${DEV_VERSION} from ${GITHUB_SHA}"
+        sed -i "s/^version = \".*\"$/version = \"${DEV_VERSION}\"/" pyproject.toml
+
+    - name: Prepare wheel build metadata
+      shell: bash
+      env:
+        PYTHON_VERSION: ${{ inputs.python-version }}
+      run: |
+        case "$PYTHON_VERSION" in
+          "3.10") echo "CIBW_BUILD=cp310-*" >> "$GITHUB_ENV" ;;
+          "3.11") echo "CIBW_BUILD=cp311-*" >> "$GITHUB_ENV" ;;
+          "3.12") echo "CIBW_BUILD=cp312-*" >> "$GITHUB_ENV" ;;
+          "3.13") echo "CIBW_BUILD=cp313-*" >> "$GITHUB_ENV" ;;
+          *) echo "Unsupported Python version: $PYTHON_VERSION" >&2; exit 1 ;;
+        esac
+
+    - name: Build plugin package
+      shell: bash
+      env:
+        CIBW_ARCHS: auto64
+        CIBW_BEFORE_BUILD_LINUX: "python -m pip install cmake ninja pybind11==3.0.1 scikit-build-core==0.11.6"
+        CIBW_BEFORE_BUILD_MACOS: "python -m pip install cmake ninja pybind11==3.0.1 scikit-build-core==0.11.6"
+        CIBW_BEFORE_BUILD_WINDOWS: "python -m pip install cmake ninja pybind11==3.0.1 scikit-build-core==0.11.6"
+        CIBW_BUILD_VERBOSITY: 1
+        CIBW_ENVIRONMENT: PIP_INDEX_URL=${{ env.PIP_INDEX_URL || 'https://pypi.org/simple' }}
+        CIBW_ENVIRONMENT_MACOS: PIP_INDEX_URL=${{ env.PIP_INDEX_URL || 'https://pypi.org/simple' }} MACOSX_DEPLOYMENT_TARGET=11.0
+        CIBW_ENVIRONMENT_WINDOWS: PIP_INDEX_URL=${{ env.PIP_INDEX_URL || 'https://pypi.org/simple' }}
+        CIBW_MANYLINUX_AARCH64_IMAGE: manylinux_2_28
+        CIBW_MANYLINUX_X86_64_IMAGE: manylinux_2_28
+        CIBW_SKIP: "*-musllinux_*"
+      run: |
+        python -m pip install cibuildwheel==2.23.3
+        python -m cibuildwheel --output-dir wheelhouse
+
+        mkdir -p dist
+        mv wheelhouse/*.whl dist/
+
+    - name: Build source distribution
+      if: inputs.build-sdist == 'true' && runner.os == 'Linux' && runner.arch == 'X64'
+      shell: bash
+      run: |
+        python -m pip install build
+        python -m build --sdist
+
+    - name: Upload plugin package artifact
+      uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+      with:
+        name: ${{ inputs.artifact-name }}
+        path: dist

vgf_adapter_model_explorer-0.5.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: "weekly"
+    timezone: Europe/London
+  open-pull-requests-limit: 10
+  rebase-strategy: disabled

vgf_adapter_model_explorer-0.5.0/.github/workflows/blackduck-full-scan.yml

@@ -0,0 +1,45 @@
+name: Black Duck Full Scan
+
+on:
+  workflow_dispatch:
+    inputs:
+      project-version:
+        description: "Black Duck project version name, for example 0.4.1 or pr-29-<sha>."
+        required: true
+        type: string
+      project-name:
+        description: "Black Duck project name. Leave empty to use the repository name."
+        required: false
+        default: ""
+        type: string
+      source-path:
+        description: "Path to scan."
+        required: false
+        default: "."
+        type: string
+      python-dependencies:
+        description: "Install requirement*.txt files into a venv and pass it to Detect."
+        required: true
+        default: false
+        type: boolean
+      snippet-matching:
+        description: "Enable Black Duck snippet matching."
+        required: true
+        default: false
+        type: boolean
+
+permissions:
+  contents: read
+
+jobs:
+  blackduck:
+    if: ${{ github.event.repository.private }}
+    uses: Arm-Debug/github-workflow-wizardry/.github/workflows/blackduck-full-scan.yml@main
+    with:
+      project-name: ${{ inputs['project-name'] }}
+      project-version: ${{ inputs['project-version'] }}
+      source-path: ${{ inputs['source-path'] }}
+      python-dependencies: ${{ inputs['python-dependencies'] }}
+      snippet-matching: ${{ inputs['snippet-matching'] }}
+    secrets:
+      BLACKDUCK_API_TOKEN: ${{ secrets.BLACKDUCK_API_TOKEN }}

vgf_adapter_model_explorer-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,292 @@
+name: VGF Adapter for Model Explorer CI
+
+on:
+  push:
+    branches: ["main"]
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+  schedule:
+    - cron: "0 3 */6 * *"
+
+env:
+  DEFAULT_PY_VERSION: "3.10"
+  ME_REPO_ACCESS_APP_ID: ${{ secrets.ME_REPO_ACCESS_APP_ID }}
+  ME_REPO_ACCESS_PRIVATE_KEY: ${{ secrets.ME_REPO_ACCESS_PRIVATE_KEY }}
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Run tests
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        runner: ${{ fromJSON(vars.TEST_RUNNERS) }}
+    runs-on: ${{ matrix.runner }}
+    env:
+      HATCH_DATA_DIR: ${{ github.workspace }}/.hatch-data-py${{ matrix.python-version }}
+      HATCH_CACHE_DIR: ${{ github.workspace }}/.hatch-cache-py${{ matrix.python-version }}
+    steps:
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Checkout plugin repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - name: Install Hatch
+        env:
+          PIP_INDEX_URL: ${{ secrets.INTERNAL_PYPI_AUTH_INDEX_URL || 'https://pypi.org/simple' }}
+        run: |
+          python -m pip install hatch==1.14.1 virtualenv==20.26.6
+
+      - name: Lint and Format Check
+        run: |
+          hatch run ci:lint
+          hatch run ci:format-check
+
+      - name: Type Check
+        run: |
+          hatch run ci:type-check
+
+      - name: Run Tests
+        shell: bash
+        env:
+          PIP_INDEX_URL: ${{ secrets.INTERNAL_PYPI_AUTH_INDEX_URL || 'https://pypi.org/simple' }}
+          MATRIX_RUNNER: ${{ matrix.runner }}
+          LINUX_RUNNER: ${{ vars.LINUX_RUNNER }}
+          MATRIX_PYTHON_VERSION: ${{ matrix.python-version }}
+          DEFAULT_PY_VERSION: ${{ env.DEFAULT_PY_VERSION }}
+        run: |
+          PYTEST_CVG_FLAGS=""
+          if [[ "$MATRIX_RUNNER" == "$LINUX_RUNNER" && \
+              "$MATRIX_PYTHON_VERSION" == "$DEFAULT_PY_VERSION" ]]; then
+            PYTEST_CVG_FLAGS="-v --cov=vgf_adapter_model_explorer --cov-report=lcov:reports/lcov.info"
+          fi
+          hatch run ci:test -- ${PYTEST_CVG_FLAGS}
+
+      - name: Upload coverage to Qlty
+        if: matrix.runner == vars.LINUX_RUNNER && matrix.python-version == env.DEFAULT_PY_VERSION
+        uses: qltysh/qlty-action/coverage@9e8e09dfc3d82a968f4034f5265eaf3c142881f7 # v2.0.0
+        with:
+          token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
+          files: reports/lcov.info
+
+  build:
+    name: Build Package
+    needs: [tests]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+        runner: ${{ fromJSON(vars.TEST_RUNNERS) }}
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+
+      - uses: ./.github/actions/build-wheel
+        env:
+          PIP_INDEX_URL: ${{ secrets.INTERNAL_PYPI_AUTH_INDEX_URL || 'https://pypi.org/simple' }}
+        with:
+          python-version: ${{ matrix.python-version }}
+          internal-dev-version: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository_owner != 'arm' }}
+          artifact-name: dist-${{ runner.os }}-${{ runner.arch }}-py${{ matrix.python-version }}
+          build-sdist: ${{ runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION }}
+
+      - name: Create wheel SBOM output directory
+        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION
+        run: mkdir -p sbom
+
+      - name: Generate wheel SBOM
+        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION
+        env:
+          PIP_INDEX_URL: ${{ secrets.INTERNAL_PYPI_AUTH_INDEX_URL || 'https://pypi.org/simple' }}
+        run: |
+          python -m pip install --index-url https://pypi.org/simple cyclonedx-bom==7.3.0
+          python -m venv .sbom-venv
+          .sbom-venv/bin/python -m pip install --upgrade pip
+          .sbom-venv/bin/python -m pip install dist/*.whl
+          python -m cyclonedx_py environment .sbom-venv/bin/python \
+            --output-format JSON \
+            --output-file sbom/vgf-adapter-model-explorer-wheel.cdx.json
+
+      - name: Add SBOM disclaimer
+        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION
+        run: |
+          python scripts/add-sbom-disclaimer.py \
+            sbom/vgf-adapter-model-explorer-wheel.cdx.json
+
+      - name: Download adapter SBOMs
+        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          python scripts/download-adapter-sboms.py \
+            --github-token "$GITHUB_TOKEN"
+
+      - name: Upload wheel SBOM artifact
+        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.python-version == env.DEFAULT_PY_VERSION
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: project-sbom
+          path: |
+            sbom/**/*.json
+            sbom/dependencies/adapter-sbom-manifest.json
+          if-no-files-found: error
+
+  release:
+    name: Release
+    if: startsWith(github.ref, 'refs/tags/') && github.repository_owner == 'arm'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/vgf-adapter-model-explorer
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: getsentry/action-github-app-token@d4b5da6c5e37703f8c3b3e43abb5705b46e159cc #v3.0.0
+        id: get_app_token
+        with:
+          app_id: ${{ env.ME_REPO_ACCESS_APP_ID }}
+          private_key: ${{ env.ME_REPO_ACCESS_PRIVATE_KEY }}
+
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+          token: ${{ steps.get_app_token.outputs.token }}
+          persist-credentials: false
+
+      - name: Generate release notes
+        uses: orhun/git-cliff-action@d77b37db2e3f7398432d34b72a12aa3e2ba87e51 # v4.6.0
+        id: git-cliff
+        with:
+          config: cliff.toml
+          args: --latest
+        env:
+          OUTPUT: CHANGELOG.md
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_REPO: ${{ github.repository }}
+
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with:
+          pattern: dist-*
+          path: dist/
+          merge-multiple: true
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1.12.4
+
+      - name: Download project SBOM
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with:
+          name: project-sbom
+          path: sbom/
+
+      - name: Publish GitHub release
+        uses: softprops/action-gh-release@5be0e66d93ac7ed76da52eca8bb058f665c3a5fe # v2.4.2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body_path: CHANGELOG.md
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+            sbom/**/*.json
+          token: ${{ steps.get_app_token.outputs.token }}
+
+  release-internal:
+    name: Release to internal PyPI
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) && github.repository_owner != 'arm'
+    needs:
+      - build
+    runs-on: ${{ vars.LINUX_RUNNER }}
+    permissions: {}
+
+    steps:
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ env.DEFAULT_PY_VERSION }}
+
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+        with:
+          pattern: dist-*
+          path: dist/
+          merge-multiple: true
+
+      - name: Publish distribution to internal PyPI
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1.12.4
+        with:
+          repository-url: ${{ vars.INTERNAL_PYPI_UPLOAD_URL }}
+          user: ${{ secrets.INTERNAL_PYPI_USERNAME }}
+          password: ${{ secrets.INTERNAL_PYPI_TOKEN }}
+          packages-dir: dist/
+          attestations: false
+
+  sync-commits-to-public-repo:
+    name: Sync commits to public repo
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository_owner != 'arm'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+      - name: Checkout target repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          repository: arm/vgf-adapter-model-explorer
+          token: ${{ secrets.ARM_ORG_TOKEN }}
+          path: target-repo
+          persist-credentials: true
+      - name: Push commits to public repo
+        env:
+          SOURCE_URL: ${{ github.server_url }}/${{ github.repository }}
+        run: |
+          cd target-repo
+          git remote add source "$SOURCE_URL"
+          git fetch source main
+          git checkout main
+          git merge source/main
+          git push origin main
+
+  sync-release-tags-to-public-repo:
+    name: Sync release tags to public repo
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') && github.repository_owner != 'arm'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+      - name: Checkout target repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          repository: arm/vgf-adapter-model-explorer
+          token: ${{ secrets.ARM_ORG_TOKEN }}
+          path: target-repo
+          persist-credentials: true
+      - name: Push tags to public repo
+        env:
+          REF_NAME: ${{ github.ref_name }}
+          SOURCE_URL: ${{ github.server_url }}/${{ github.repository }}
+        run: |
+          cd target-repo
+          git remote add source "$SOURCE_URL"
+          git fetch source --tags
+          git push origin "refs/tags/$REF_NAME"

vgf_adapter_model_explorer-0.5.0/.github/workflows/codex-pr-review.yml

@@ -0,0 +1,16 @@
+name: Codex PR Review
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, edited]
+
+jobs:
+  codex-review:
+    if: >-
+      ${{ github.repository_owner != 'arm' &&
+      (github.event.action != 'edited' || github.event.changes.base != null) }}
+    uses: Arm-Debug/github-workflow-wizardry/.github/workflows/codex-pr-review.yaml@53cefff20e3f7fd5079e41a258ef812c9fcf3a45
+    with:
+      codex_proxy_url: ${{ vars.CODEX_PROXY_URL }}
+    secrets:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}