isotope-pattern-lib 1.0.0__tar.gz

isotope_pattern_lib-1.0.0/.github/scripts/compute-next-version.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+# Computes the next release version from a PR title ([MAJOR]/[MINOR]/[PATCH])
+# and the latest existing "X.Y.Z" git tag. Prints the version to stdout.
+set -euo pipefail
+
+title="${1:?usage: compute-next-version.sh <pr-title>}"
+
+if echo "$title" | grep -qi '\[major\]'; then
+  bump="major"
+elif echo "$title" | grep -qi '\[minor\]'; then
+  bump="minor"
+elif echo "$title" | grep -qi '\[patch\]'; then
+  bump="patch"
+else
+  echo "PR title must contain one of [MAJOR], [MINOR], [PATCH]: '${title}'" >&2
+  exit 1
+fi
+
+latest_tag=$(git tag --list | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | sort -t. -k1,1n -k2,2n -k3,3n | tail -1 || true)
+
+if [ -z "$latest_tag" ]; then
+  if [ "$bump" != "major" ]; then
+    echo "No existing release tag found; a [${bump}] PR cannot be the first release, only [MAJOR] can" >&2
+    exit 1
+  fi
+  echo "1.0.0"
+  exit 0
+fi
+
+IFS='.' read -r major minor patch <<< "$latest_tag"
+
+case "$bump" in
+  major)
+    echo "$((major + 1)).0.0"
+    ;;
+  minor)
+    echo "${major}.$((minor + 1)).0"
+    ;;
+  patch)
+    echo "${major}.${minor}.$((patch + 1))"
+    ;;
+esac

isotope_pattern_lib-1.0.0/.github/workflows/ci-branch.yaml

@@ -0,0 +1,121 @@
+name: ci-branch
+env:
+  SONARCLOUD_TASK_URL: https://sonarcloud.io/api/ce/task
+  SONARCLOUD_PROJECT_STATUS_URL: https://sonarcloud.io/api/qualitygates/project_status
+  UV_PYTHON: "3.12"
+on:
+  push:
+    branches:
+      - '**'
+      - '!master'
+jobs:
+  test-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: running unit tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/unit --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/unit/coverage-report.xml
+      - name: running integration tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/integration --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/integration/coverage-report.xml
+      - name: saving artifacts
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: ./artifacts
+  # Fan-in gate: matrix jobs report as "test-matrix (3.9)" etc, not a single
+  # "tests" check, which breaks branch protection rules pinned to that name.
+  # This job restores a single, stably-named required check.
+  tests:
+    needs: test-matrix
+    runs-on: ubuntu-latest
+    steps:
+      - name: all python version matrix legs passed
+        run: echo "All test-matrix legs passed"
+  code-analysis:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: branch name extraction
+        id: branch_extraction
+        run: echo "##[set-output name=branch_name;]$(echo ${GITHUB_REF#refs/heads/})"
+      - name: loading artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+      - name: SonarCloud scan
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          unzip ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          rm ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          mv ./sonar-scanner-8.1.0.6389-linux-x64 /opt
+          mv /opt/sonar-scanner-8.1.0.6389-linux-x64 /opt/sonar-scanner
+          /opt/sonar-scanner/bin/sonar-scanner \
+            -Dsonar.organization=${{secrets.SONARCLOUD_ORGANIZATION}} \
+            -Dsonar.projectKey=${{secrets.SONARCLOUD_PROJECT_KEY}} \
+            -Dsonar.sources=isotope_pattern_lib \
+            -Dsonar.tests=tests \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.python.coverage.reportPaths=test-report/**/coverage-report.xml \
+            -Dsonar.exclusions=test-report/** \
+            -Dsonar.branch.name=${{steps.branch_extraction.outputs.branch_name}}
+      - name: SonarCloud quality gate evaluation
+        env:
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          taskId=$(awk -v FS="ceTaskId=" 'NF>1{print $2}' .scannerwork/report-task.txt)
+          echo "taskId=${taskId}"
+
+          status="PENDING"
+          for i in $(seq 1 30); do
+            taskResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_TASK_URL}}?id=${taskId}")
+            status=$(echo "$taskResponse" | jq -r '.task.status')
+            echo "CE task status: ${status}"
+            if [ "$status" = "SUCCESS" ] || [ "$status" = "FAILED" ] || [ "$status" = "CANCELED" ]; then
+              break
+            fi
+            sleep 5
+          done
+
+          if [ "$status" != "SUCCESS" ]; then
+            echo "SonarCloud analysis task did not complete successfully (status: ${status})"
+            echo "Full task response: ${taskResponse}"
+            exit 1
+          fi
+
+          analysisId=$(echo "$taskResponse" | jq -r '.task.analysisId')
+          echo "analysisId=${analysisId}"
+          qualityGateResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_PROJECT_STATUS_URL}}?analysisId=${analysisId}")
+          qualityGateStatus=$(echo "$qualityGateResponse" | jq -r '.projectStatus.status // empty')
+          echo "Quality gate status: ${qualityGateStatus:-<none>}"
+
+          if [ -z "$qualityGateStatus" ]; then
+            echo "Could not read quality gate status, full response: ${qualityGateResponse}"
+            exit 1
+          fi
+
+          if [ "$qualityGateStatus" = "ERROR" ]; then
+            echo "The quality gate was not passed"
+            exit 1
+          fi

isotope_pattern_lib-1.0.0/.github/workflows/ci-master.yaml

@@ -0,0 +1,181 @@
+name: ci-master
+env:
+  SONARCLOUD_TASK_URL: https://sonarcloud.io/api/ce/task
+  SONARCLOUD_PROJECT_STATUS_URL: https://sonarcloud.io/api/qualitygates/project_status
+  UV_PYTHON: "3.12"
+on:
+  push:
+    branches:
+      - master
+jobs:
+  test-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: running unit tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/unit --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/unit/coverage-report.xml
+      - name: running integration tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/integration --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/integration/coverage-report.xml
+      - name: saving artifacts
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: ./artifacts
+  # Fan-in gate: matrix jobs report as "test-matrix (3.9)" etc, not a single
+  # "tests" check, which breaks branch protection rules pinned to that name.
+  # This job restores a single, stably-named required check.
+  tests:
+    needs: test-matrix
+    runs-on: ubuntu-latest
+    steps:
+      - name: all python version matrix legs passed
+        run: echo "All test-matrix legs passed"
+  code-analysis:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: loading artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+      - name: SonarCloud scan
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          unzip ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          rm ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          mv ./sonar-scanner-8.1.0.6389-linux-x64 /opt
+          mv /opt/sonar-scanner-8.1.0.6389-linux-x64 /opt/sonar-scanner
+          /opt/sonar-scanner/bin/sonar-scanner \
+            -Dsonar.organization=${{secrets.SONARCLOUD_ORGANIZATION}} \
+            -Dsonar.projectKey=${{secrets.SONARCLOUD_PROJECT_KEY}} \
+            -Dsonar.sources=isotope_pattern_lib \
+            -Dsonar.tests=tests \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.python.coverage.reportPaths=test-report/**/coverage-report.xml \
+            -Dsonar.exclusions=test-report/** \
+            -Dsonar.branch.name=master
+      - name: SonarCloud quality gate evaluation
+        env:
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          taskId=$(awk -v FS="ceTaskId=" 'NF>1{print $2}' .scannerwork/report-task.txt)
+          echo "taskId=${taskId}"
+
+          status="PENDING"
+          for i in $(seq 1 30); do
+            taskResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_TASK_URL}}?id=${taskId}")
+            status=$(echo "$taskResponse" | jq -r '.task.status')
+            echo "CE task status: ${status}"
+            if [ "$status" = "SUCCESS" ] || [ "$status" = "FAILED" ] || [ "$status" = "CANCELED" ]; then
+              break
+            fi
+            sleep 5
+          done
+
+          if [ "$status" != "SUCCESS" ]; then
+            echo "SonarCloud analysis task did not complete successfully (status: ${status})"
+            echo "Full task response: ${taskResponse}"
+            exit 1
+          fi
+
+          analysisId=$(echo "$taskResponse" | jq -r '.task.analysisId')
+          echo "analysisId=${analysisId}"
+          qualityGateResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_PROJECT_STATUS_URL}}?analysisId=${analysisId}")
+          qualityGateStatus=$(echo "$qualityGateResponse" | jq -r '.projectStatus.status // empty')
+          echo "Quality gate status: ${qualityGateStatus:-<none>}"
+
+          if [ -z "$qualityGateStatus" ]; then
+            echo "Could not read quality gate status, full response: ${qualityGateResponse}"
+            exit 1
+          fi
+
+          if [ "$qualityGateStatus" = "ERROR" ]; then
+            echo "The quality gate was not passed"
+            exit 1
+          fi
+  tag-release:
+    needs: [tests, code-analysis]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.tag.outputs.version }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: find merged PR title
+        id: pr
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          title=$(gh api "repos/${{ github.repository }}/commits/${{ github.sha }}/pulls" --jq '.[0].title // empty')
+          if [ -z "$title" ]; then
+            echo "No pull request associated with this push; skipping release tagging" >&2
+            exit 1
+          fi
+          echo "title=${title}" | tee -a "$GITHUB_OUTPUT"
+      - name: compute next version
+        id: version
+        env:
+          PR_TITLE: ${{ steps.pr.outputs.title }}
+        run: |
+          version=$(.github/scripts/compute-next-version.sh "$PR_TITLE")
+          echo "version=${version}" | tee -a "$GITHUB_OUTPUT"
+      - name: create and push release tag
+        id: tag
+        env:
+          VERSION: ${{ steps.version.outputs.version }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "${VERSION}" -m "Release ${VERSION}"
+          git push origin "${VERSION}"
+          echo "version=${VERSION}" | tee -a "$GITHUB_OUTPUT"
+  publish:
+    needs: tag-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.tag-release.outputs.version }}
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ env.UV_PYTHON }}
+          enable-cache: true
+      - name: set release version
+        env:
+          VERSION: ${{ needs.tag-release.outputs.version }}
+        run: |
+          sed -i "s/^version = \".*\"/version = \"${VERSION}\"/" pyproject.toml
+      - name: build package
+        run: uv build
+      - name: publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish dist/*

isotope_pattern_lib-1.0.0/.github/workflows/ci-pull-request.yaml

@@ -0,0 +1,209 @@
+name: ci-pull-request
+env:
+  SONARCLOUD_TASK_URL: https://sonarcloud.io/api/ce/task
+  SONARCLOUD_PROJECT_STATUS_URL: https://sonarcloud.io/api/qualitygates/project_status
+  UV_PYTHON: "3.12"
+on:
+  pull_request:
+    branches:
+      - master
+    types: [opened, edited, synchronize, reopened]
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    outputs:
+      next_version: ${{ steps.compute.outputs.version }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: compute next version from PR title
+        id: compute
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          version=$(.github/scripts/compute-next-version.sh "$PR_TITLE")
+          echo "version=${version}" | tee -a "$GITHUB_OUTPUT"
+  test-matrix:
+    needs: validate-pr-title
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - name: running unit tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/unit --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/unit/coverage-report.xml
+      - name: running integration tests
+        run: |
+          uv run --python ${{ matrix.python-version }} --group test pytest tests/integration --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/integration/coverage-report.xml
+      - name: saving artifacts
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: ./artifacts
+  # Fan-in gate: matrix jobs report as "test-matrix (3.9)" etc, not a single
+  # "tests" check, which breaks branch protection rules pinned to that name.
+  # This job restores a single, stably-named required check.
+  tests:
+    needs: test-matrix
+    runs-on: ubuntu-latest
+    steps:
+      - name: all python version matrix legs passed
+        run: echo "All test-matrix legs passed"
+  code-analysis:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: loading artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+      - name: SonarCloud scan
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          unzip ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          rm ./sonar-scanner-cli-8.1.0.6389-linux-x64.zip
+          mv ./sonar-scanner-8.1.0.6389-linux-x64 /opt
+          mv /opt/sonar-scanner-8.1.0.6389-linux-x64 /opt/sonar-scanner
+          /opt/sonar-scanner/bin/sonar-scanner \
+            -Dsonar.organization=${{secrets.SONARCLOUD_ORGANIZATION}} \
+            -Dsonar.projectKey=${{secrets.SONARCLOUD_PROJECT_KEY}} \
+            -Dsonar.sources=isotope_pattern_lib \
+            -Dsonar.tests=tests \
+            -Dsonar.host.url=https://sonarcloud.io \
+            -Dsonar.python.coverage.reportPaths=test-report/**/coverage-report.xml \
+            -Dsonar.exclusions=test-report/** \
+            -Dsonar.pullrequest.key=${{github.event.pull_request.number}}
+      - name: SonarCloud quality gate evaluation
+        env:
+          SONAR_TOKEN: ${{secrets.SONARCLOUD_TOKEN}}
+        run: |
+          taskId=$(awk -v FS="ceTaskId=" 'NF>1{print $2}' .scannerwork/report-task.txt)
+          echo "taskId=${taskId}"
+
+          status="PENDING"
+          for i in $(seq 1 30); do
+            taskResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_TASK_URL}}?id=${taskId}")
+            status=$(echo "$taskResponse" | jq -r '.task.status')
+            echo "CE task status: ${status}"
+            if [ "$status" = "SUCCESS" ] || [ "$status" = "FAILED" ] || [ "$status" = "CANCELED" ]; then
+              break
+            fi
+            sleep 5
+          done
+
+          if [ "$status" != "SUCCESS" ]; then
+            echo "SonarCloud analysis task did not complete successfully (status: ${status})"
+            echo "Full task response: ${taskResponse}"
+            exit 1
+          fi
+
+          analysisId=$(echo "$taskResponse" | jq -r '.task.analysisId')
+          echo "analysisId=${analysisId}"
+          qualityGateResponse=$(curl -s -u "${SONAR_TOKEN}:" --location --request GET "${{env.SONARCLOUD_PROJECT_STATUS_URL}}?analysisId=${analysisId}")
+          qualityGateStatus=$(echo "$qualityGateResponse" | jq -r '.projectStatus.status // empty')
+          echo "Quality gate status: ${qualityGateStatus:-<none>}"
+
+          if [ -z "$qualityGateStatus" ]; then
+            echo "Could not read quality gate status, full response: ${qualityGateResponse}"
+            exit 1
+          fi
+
+          if [ "$qualityGateStatus" = "ERROR" ]; then
+            echo "The quality gate was not passed"
+            exit 1
+          fi
+  e2e-publish:
+    needs: [tests, validate-pr-title]
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ env.UV_PYTHON }}
+          enable-cache: true
+      - name: compute unique dev version
+        id: version
+        env:
+          NEXT_VERSION: ${{ needs.validate-pr-title.outputs.next_version }}
+        run: |
+          dev_version="${NEXT_VERSION}.dev${{ github.run_id }}${{ github.run_attempt }}"
+          echo "version=${dev_version}" | tee -a "$GITHUB_OUTPUT"
+          sed -i "s/^version = \".*\"/version = \"${dev_version}\"/" pyproject.toml
+      - name: build package
+        run: uv build
+      - name: publish to TestPyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.TEST_PYPI_TOKEN }}
+        run: uv publish --publish-url https://test.pypi.org/legacy/ dist/*
+  e2e-verify:
+    needs: e2e-publish
+    runs-on: ubuntu-latest
+    steps:
+      # Sparse-checkout only `tests/`: `isotope_pattern_lib` must NOT be present
+      # in the working tree here, otherwise `python -m pytest` would resolve
+      # imports to the local source instead of the package installed from
+      # TestPyPI below, silently defeating this job's purpose.
+      - name: checkout tests only
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            tests
+          sparse-checkout-cone-mode: true
+      - name: install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ env.UV_PYTHON }}
+          enable-cache: true
+      - name: create e2e virtual environment
+        run: uv venv .e2e-venv
+      - name: install package from TestPyPI
+        env:
+          VERSION: ${{ needs.e2e-publish.outputs.version }}
+        run: |
+          for attempt in $(seq 1 5); do
+            if uv pip install --python .e2e-venv \
+              --index-url https://test.pypi.org/simple/ \
+              --extra-index-url https://pypi.org/simple/ \
+              "isotope-pattern-lib==${VERSION}"; then
+              exit 0
+            fi
+            echo "package not yet available on TestPyPI, retrying in 15s (attempt ${attempt}/5)"
+            sleep 15
+          done
+          echo "failed to install isotope-pattern-lib==${VERSION} from TestPyPI"
+          exit 1
+      - name: install e2e test dependencies
+        run: uv pip install --python .e2e-venv pytest pytest-bdd pytest-cov pyyaml
+      - name: running e2e tests against published artifact
+        run: |
+          .e2e-venv/bin/python -m pytest tests/integration --cov=isotope_pattern_lib --cov-report=xml:./artifacts/test-report/e2e/coverage-report.xml
+      - name: saving e2e artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2e-coverage-report
+          path: ./artifacts

isotope_pattern_lib-1.0.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+artifacts/
+*.egg-info/
+.idea/
+.DS_Store
+.coverage
+.scannerwork/
+.venv/
+dist/