easydiffraction 0.7.2__tar.gz → 0.8.0__tar.gz

easydiffraction-0.8.0/.badgery.yaml

@@ -0,0 +1,74 @@
+default_branch: master
+develop_branch: develop
+
+cards:
+  - group: Tests
+    type: gh_action
+    title: Code/package tests (GitHub)
+    file: test.yaml
+    enabled: true
+
+  - group: Tests
+    type: gh_action
+    title: Tutorial tests (GitHub)
+    file: tutorial-tests.yaml
+    enabled: true
+
+  - group: Tests
+    type: gh_action
+    title: Package tests (PyPI)
+    file: pypi-test.yaml
+    enabled: true
+
+  - group: Code Quality
+    type: codefactor
+    title: Code quality (CodeFactor)
+    enabled: true
+
+  - group: Code Quality
+    type: radon_mi
+    title: Maintainability index (radon)
+    report: reports/{branch}/maintainability-index.json
+    enabled: true
+
+  - group: Code Quality
+    type: radon_cc
+    title: Cyclomatic complexity (radon)
+    report: reports/{branch}/cyclomatic-complexity.json
+    enabled: true
+
+  - group: Size
+    type: radon_loc
+    title: Source/Logical lines of code (radon)
+    report: reports/{branch}/raw-metrics.json
+    enabled: true
+
+  - group: Size
+    type: radon_ff
+    title: Functions/Files count (radon)
+    report: reports/{branch}/cyclomatic-complexity.json
+    enabled: true
+
+  - group: Coverage
+    type: codecov
+    title: Unit test coverage (Codecov)
+    flag: unittests
+    enabled: true
+
+  - group: Coverage
+    type: interrogate
+    title: Docstring coverage (interrogate)
+    report: reports/{branch}/coverage-docstring.txt
+    enabled: true
+
+  - group: Build & Release
+    type: gh_action
+    title: Publishing (PyPI)
+    workflow: pypi-publish.yaml
+    enabled: true
+
+  - group: Build & Release
+    type: gh_action
+    title: Docs build/deployment
+    workflow: docs.yaml
+    enabled: true

easydiffraction-0.8.0/.github/workflows/backmerge-pr.yaml

@@ -0,0 +1,96 @@
+# This workflow creates a backmerge PR into `develop` whenever a new version tag is pushed (v*).
+#
+# Key points:
+# - The PR head is a temporary branch that points at the *tag commit* (refs/tags/vX.Y.Z).
+#   After merging, `develop` can `git describe` as vX.Y.Z-... because the tag commit becomes an ancestor.
+# - The PR is auto-merged using a MERGE COMMIT (not squash) via a GitHub App token.
+#   The GitHub App must be added to the develop ruleset bypass list.
+#
+# Required repo config:
+# - Actions secret:   ES_BACKMERGE_PRIVATE_KEY  (GitHub App private key PEM)
+# - Actions variable: ES_BACKMERGE_APP_ID       (GitHub App ID)
+
+name: Backmerge PR (tag -> develop)
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  create-backmerge-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Create GitHub App installation token
+        id: app-token
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ vars.ES_BACKMERGE_APP_ID }}
+          private-key: ${{ secrets.ES_BACKMERGE_PRIVATE_KEY }}
+
+      - name: Checkout tag commit
+        uses: actions/checkout@v5
+        with:
+          ref: ${{ github.ref }} # refs/tags/vX.Y.Z
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Create and push backmerge branch at tag
+        id: vars
+        run: |
+          set -euo pipefail
+
+          TAG='${{ github.ref_name }}'
+          BRANCH="backmerge/${TAG}"
+
+          echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
+          echo "branch=${BRANCH}" >> "$GITHUB_OUTPUT"
+
+          git config user.name  "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Create/move branch to point exactly at the tag commit
+          git checkout -B "$BRANCH"
+
+          # Push (force makes re-runs idempotent for the same tag)
+          git push --force --set-upstream origin "$BRANCH"
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+
+      - name:
+          Create PR from tag backmerge branch to develop (or reuse if exists)
+        run: |
+          set -euo pipefail
+
+          TITLE="Backmerge: ${{ steps.vars.outputs.tag }} into develop"
+
+          BODY="⚠️ This PR is created automatically for backmerge of a new release tag commit \`${{ steps.vars.outputs.tag }}\` into \`develop\`.
+
+          It is labeled '[maintainer] auto-pull-request' and is excluded from release notes and version bump logic."
+
+          if gh pr view --repo "${{ github.repository }}" --head "${{ steps.vars.outputs.branch }}" >/dev/null 2>&1; then
+            echo "PR already exists for head=${{ steps.vars.outputs.branch }}"
+          else
+            gh pr create \
+              --repo "${{ github.repository }}" \
+              --base develop \
+              --head "${{ steps.vars.outputs.branch }}" \
+              --title "$TITLE" \
+              --label "[maintainer] auto-pull-request" \
+              --body "$BODY"
+          fi
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+
+      - name: Enable auto-merge using MERGE COMMIT
+        run: |
+          set -euo pipefail
+          # Merge the PR identified by its head branch.
+          gh pr merge --repo "${{ github.repository }}" --merge --auto "${{ steps.vars.outputs.branch }}"
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}

easydiffraction-0.7.2/.github/workflows/delete-old-runs.yml → easydiffraction-0.8.0/.github/workflows/cleanup.yaml

@@ -2,7 +2,7 @@
 # parameters.
 # https://github.com/Mattraks/delete-workflow-runs
 
-name: Delete old workflow runs
+name: Old workflow runs cleanup
 
 on:
   # Run monthly, at 00:00 on the 1st day of month.

easydiffraction-0.8.0/.github/workflows/coverage.yaml

@@ -0,0 +1,147 @@
+name: Coverage checks
+
+on:
+  # Trigger the workflow on push
+  push:
+  # Trigger the workflow on pull request
+  pull_request:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Need permissions to trigger the dashboard build workflow
+permissions:
+  actions: write
+  contents: read
+
+# Allow only one concurrent workflow, skipping runs queued between the run
+# in-progress and latest queued. And cancel in-progress runs.
+concurrency:
+  group:
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  # Job 1: Run docstring coverage
+  docstring-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v5
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
+        with:
+          environments: default
+          activate-environment: default
+          run-install: true
+          frozen: true
+          cache: false
+          post-cleanup: false
+
+      - name: Install and setup development dependencies
+        shell: bash
+        run: pixi run dev
+
+      - name: Run docstring coverage
+        run: pixi run docstring-coverage
+
+  # Job 2: Run unit tests with coverage and upload to Codecov
+  unit-tests-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v5
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
+        with:
+          environments: default
+          activate-environment: default
+          run-install: true
+          frozen: true
+          cache: false
+          post-cleanup: false
+
+      - name: Install and setup development dependencies
+        shell: bash
+        run: pixi run dev
+
+      - name: Run unit tests with coverage
+        run: pixi run unit-tests-coverage --cov-report=xml:coverage-unit.xml
+
+      - name: Upload unit tests coverage to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/codecov-action@v5
+        with:
+          name: unit-tests-job
+          flags: unittests
+          files: ./coverage-unit.xml
+          fail_ci_if_error: true
+          verbose: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Job 2: Run integration tests with coverage and upload to Codecov
+  integration-tests-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v5
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
+        with:
+          environments: default
+          activate-environment: default
+          run-install: true
+          frozen: true
+          cache: false
+          post-cleanup: false
+
+      - name: Install and setup development dependencies
+        shell: bash
+        run: pixi run dev
+
+      - name: Run integration tests with coverage
+        run:
+          pixi run integration-tests-coverage
+          --cov-report=xml:coverage-integration.xml
+
+      - name: Upload integration tests coverage to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/codecov-action@v5
+        with:
+          name: integration-tests-job
+          flags: integration
+          files: ./coverage-integration.xml
+          fail_ci_if_error: true
+          verbose: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Job 4: Trigger dashboard build
+  dashboard-build-trigger:
+    needs: [docstring-coverage, unit-tests-coverage, integration-tests-coverage] # depend on the previous jobs
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v5
+
+      - name: Trigger dashboard build
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              workflow_id: "dashboard.yaml",
+              ref: "${{ env.CI_BRANCH }}"
+            });

easydiffraction-0.8.0/.github/workflows/dashboard.yaml

@@ -0,0 +1,90 @@
+name: Dashboard build and publish
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+# Allow only one concurrent workflow, skipping runs queued between the run
+# in-progress and latest queued. And cancel in-progress runs.
+concurrency:
+  group:
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+  DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+  DEVELOP_BRANCH: develop
+  REPO_OWNER: ${{ github.repository_owner }}
+  REPO_NAME: ${{ github.event.repository.name }}
+
+jobs:
+  dashboard:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
+        with:
+          environments: default
+          activate-environment: default
+          run-install: true
+          frozen: true
+          cache: false
+          post-cleanup: false
+
+      - name: Install and setup development dependencies
+        shell: bash
+        run: |
+          pixi run dev
+          pixi add --pypi --git https://github.com/enhantica/badgery badgery
+
+      - name: Run docstring coverage and code complexity/maintainability checks
+        run: |
+          for BRANCH in ${{ env.DEFAULT_BRANCH }} ${{ env.DEVELOP_BRANCH }} ${{ env.CI_BRANCH }}; do
+            echo "=== Processing branch $BRANCH ==="
+            if [ -d "../$BRANCH" ]; then
+              echo "Branch $BRANCH already processed, skipping"
+              continue
+            fi
+            git worktree add ../$BRANCH origin/$BRANCH
+            mkdir -p reports/$BRANCH
+            echo "Docstring coverage for branch $BRANCH"
+            pixi run interrogate -c pyproject.toml --fail-under=0 ../$BRANCH/src > reports/$BRANCH/coverage-docstring.txt
+            echo "Cyclomatic complexity for branch $BRANCH"
+            pixi run radon cc -s -j ../$BRANCH/src > reports/$BRANCH/cyclomatic-complexity.json
+            echo "Maintainability index for branch $BRANCH"
+            pixi run radon mi -j ../$BRANCH/src > reports/$BRANCH/maintainability-index.json
+            echo "Raw metrics for branch $BRANCH"
+            pixi run radon raw -s -j ../$BRANCH/src > reports/$BRANCH/raw-metrics.json
+          done
+
+      - name: Generate dashboard HTML
+        run: >
+          pixi run python -m badgery --config .badgery.yaml --repo ${{
+          github.repository }} --branch ${{ env.CI_BRANCH }} --output index.html
+
+      - name: Prepare publish directory
+        run: |
+          mkdir -p _dashboard_publish/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}
+          cp index.html _dashboard_publish/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}
+
+      - name: Publish to main branch of ${{ github.repository }}
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          external_repository: ${{ env.REPO_OWNER }}/dashboard
+          publish_branch: ${{ env.DEFAULT_BRANCH }}
+          personal_token: ${{ secrets.GH_API_PERSONAL_ACCESS_TOKEN }}
+          publish_dir: ./_dashboard_publish
+          keep_files: true
+
+      - name: Add dashboard link to summary
+        run: |
+          URL="https://${{ env.REPO_OWNER }}.github.io/dashboard/${{ env.REPO_NAME }}/${{ env.CI_BRANCH }}"
+          echo "Dashboard link: [$URL]($URL)" >> $GITHUB_STEP_SUMMARY

easydiffraction-0.7.2/.github/workflows/build-docs.yml → easydiffraction-0.8.0/.github/workflows/docs.yaml

@@ -14,17 +14,17 @@
 # and inspecting, as well as links to both the development and production versions of
 # the deployed documentation site.
 
-name: Build and deploy docs
+name: Docs build and deployment
 
 on:
   # Trigger the workflow on pull request
   pull_request:
     # Selected branches
-    branches: [master, develop]
+    branches: [master, main, develop]
   # Trigger the workflow on push
   push:
     # Selected branches
-    branches: [master, develop]
+    branches: [master, main, develop]
     # Runs on creating a new tag starting with 'v', e.g. 'v1.0.3'
     tags: ['v*']
   # Allows you to run this workflow manually from the Actions tab
@@ -86,14 +86,17 @@ jobs:
       - name: Set up pixi
         uses: prefix-dev/setup-pixi@v0.9.0
         with:
-          environments: >-
-            py313-docs
-          activate-environment: py313-docs
+          environments: default
+          activate-environment: default
           run-install: true
           frozen: true
           cache: false
           post-cleanup: false
 
+      - name: Install and setup development dependencies
+        shell: bash
+        run: pixi run dev
+
       - name: Clone easyscience/assets-docs and easyscience/assets-branding
         run: |
           cd ..
@@ -134,7 +137,14 @@ jobs:
       # Input: docs/ directory containing the Markdown files
       # Output: site/ directory containing the generated HTML files
       - name: Build site with MkDocs
-        run: pixi run docs-build
+        run: |
+          if [[ "${CI_BRANCH}" == "develop" || "${CI_BRANCH}" == "master" || "${CI_BRANCH}" == "main" ]]; then
+            echo "📘 Building production docs for ${CI_BRANCH}"
+            pixi run docs-build
+          else
+            echo "📗 Building local docs for ${CI_BRANCH}"
+            pixi run docs-local
+          fi
 
       # Set up the Pages action to configure the static files to be deployed
       # NOTE: The repository must have GitHub Pages enabled and configured to build using GitHub Actions
@@ -226,7 +236,7 @@ jobs:
       # which triggers deployment to the custom domain via webhook.
       #
       # To be able to push to the gh_pages branch, the personal GitHub API access
-      # token GH_API_PERSONAL_ACCSESS_TOKEN must be set for this repository via
+      # token GH_API_PERSONAL_ACCESS_TOKEN must be set for this repository via
       # https://github.com/easyscience/diffraction-lib/settings/secrets/actions
       # Then the gh_pages branch is used to deploy the site to the custom domain.
       # Deploying is done with a webhook added via:
@@ -234,7 +244,7 @@ jobs:
       - name: PROD deployment to gh_pages for custom domain
         uses: s0/git-publish-subdir-action@develop
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_API_PERSONAL_ACCSESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_API_PERSONAL_ACCESS_TOKEN }}
           REPO: self
           BRANCH: gh_pages
           FOLDER: site

easydiffraction-0.8.0/.github/workflows/labels.yaml

@@ -0,0 +1,45 @@
+# Verifies if a pull request has at least one label from a set of valid
+# labels before it can be merged.
+
+name: PR label checks
+
+on:
+  pull_request_target:
+    types: [opened, labeled, unlabeled, synchronize]
+
+permissions:
+  pull-requests: read
+
+jobs:
+  require-label:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Validate required labels
+        run: |
+          PR_LABELS=$(echo '${{ toJson(github.event.pull_request.labels.*.name) }}' | jq -r '.[]')
+          echo "Current PR labels: $PR_LABELS"
+          VALID_LABELS=(
+            "[maintainer] auto-pull-request"
+            "[scope] bug"
+            "[scope] documentation"
+            "[scope] enhancement"
+            "[scope] maintenance"
+            "[scope] significant"
+          )
+
+          found=false
+          for label in "${VALID_LABELS[@]}"; do
+            if echo "$PR_LABELS" | grep -Fxq "$label"; then
+              echo "✅ Found valid label: $label"
+              found=true
+              break
+            fi
+          done
+
+          if [ "$found" = false ]; then
+            echo "ERROR: PR must have at least one of the following labels:"
+            for label in "${VALID_LABELS[@]}"; do
+              echo "       - $label"
+            done
+            exit 1
+          fi

easydiffraction-0.7.2/.github/workflows/publish-pypi.yml → easydiffraction-0.8.0/.github/workflows/pypi-publish.yaml

@@ -1,7 +1,7 @@
 # Builds a Python package and publish it to PyPI when a new tag is
 # created.
 
-name: Publish to PyPI
+name: PyPI publishing
 
 on:
   # Runs on creating a new tag starting with 'v', e.g. 'v1.0.3'
@@ -20,19 +20,22 @@ jobs:
         with:
           fetch-depth: '0' # full history with tags to get the version number by versioningit
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
         with:
-          python-version: '3.13'
+          environments: default
+          activate-environment: default
+          run-install: true
+          frozen: true
+          cache: false
+          post-cleanup: false
 
-      - name: Upgrade package installer for Python
-        run: pip install --upgrade pip
-
-      - name: Install build tool
-        run: pip install --upgrade build
+      - name: Install and setup development dependencies
+        shell: bash
+        run: pixi run dev
 
       - name: Create Python package
-        run: python -m build
+        run: pixi run python -m build
 
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

easydiffraction-0.8.0/.github/workflows/pypi-test.yaml

@@ -0,0 +1,99 @@
+name: PyPI package tests
+
+on:
+  # Run daily, at 00:00.
+  schedule:
+    - cron: '0 0 * * *'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Allow only one concurrent workflow, skipping runs queued between the run
+# in-progress and latest queued. And cancel in-progress runs.
+concurrency:
+  group:
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+# Set the environment variables to be used in all jobs defined in this workflow
+env:
+  CI_BRANCH: ${{ github.head_ref || github.ref_name }}
+  DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+
+jobs:
+  # Job 1: Test installation from PyPI on multiple OS
+  pypi-package-tests:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Set up pixi
+        uses: prefix-dev/setup-pixi@v0.9.0
+        with:
+          run-install: false
+          cache: false
+          post-cleanup: false
+
+      - name:
+          Download the pixi configuration file from the ${{ env.CI_BRANCH}}
+          branch
+        shell: bash
+        run: |
+          curl -LO https://raw.githubusercontent.com/easyscience/diffraction-lib/${CI_BRANCH}/pixi.toml
+
+      - name: Download the tests from the ${{ env.DEFAULT_BRANCH }} branch
+        shell: bash
+        run: |
+          curl -LO https://github.com/easyscience/diffraction-lib/archive/refs/heads/${DEFAULT_BRANCH}.zip
+          unzip ${DEFAULT_BRANCH}.zip -d .
+          mkdir -p tests
+          cp -r diffraction-lib-${DEFAULT_BRANCH}/tests/* tests/
+          rm -rf ${DEFAULT_BRANCH}.zip diffraction-lib-${DEFAULT_BRANCH}
+
+      - name: Create the environment and install dependencies
+        run: pixi install
+
+      - name: Install package from PyPI with all extras
+        run: pixi add --pypi "easydiffraction[all]"
+
+      - name: Run unit tests to verify the installation
+        run: pixi run unit-tests
+
+      - name: Run integration tests to verify the installation
+        run: pixi run integration-tests
+
+      # Github token to avoid hitting the unauthenticated API rate limit
+      - name: List and fetch the EasyDiffraction tutorials
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          pixi run easydiffraction --version
+          pixi run easydiffraction list-tutorials
+          pixi run easydiffraction fetch-tutorials
+
+      - name: Test tutorials as notebooks
+        run: pixi run notebook-tests
+
+  # Job 2: Trigger dashboard build
+  dashboard-build-trigger:
+    needs: pypi-package-tests
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check-out repository
+        uses: actions/checkout@v5
+
+      - name: Trigger dashboard build
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              workflow_id: "dashboard.yaml",
+              ref: "${{ env.CI_BRANCH }}"
+            });