mx-bluesky 1.5.10__tar.gz → 1.5.12__tar.gz

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2.5.0
+_commit: 4.3.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: dominic.oram@diamond.ac.uk
 author_name: Dominic Oram
@@ -9,10 +9,12 @@ component_type: library
 description: Bluesky tools for MX Beamlines at DLS
 distribution_name: mx-bluesky
 docker: true
+docker_debug: true
 docs_type: sphinx
 git_platform: github.com
 github_org: DiamondLightSource
 package_name: mx_bluesky
 pypi: true
 repo_name: mx-bluesky
+strict_typing: true
 type_checker: pyright

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.devcontainer/devcontainer.json

@@ -23,7 +23,8 @@
                 "redhat.vscode-yaml",
                 "ryanluker.vscode-coverage-gutters",
                 "charliermarsh.ruff",
-                "ms-azuretools.vscode-docker"
+                "ms-azuretools.vscode-docker",
+                "streetsidesoftware.code-spell-checker"
             ],
             "python.testing.pytestArgs": [
                 "--cov=mx_bluesky",
@@ -53,7 +54,6 @@
         }
     },
     "features": {
-        // Some default things like git config
         // add in eternal history and other bash features
         "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1": {}
     },

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/CONTRIBUTING.md

@@ -73,4 +73,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.5.0/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/4.3.0/how-to.html).

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-Describe the bug, including a clear and concise description of the expected behavior, the actual behavior and the context in which you encountered it (ideally include details of your environment).
+Describe the bug, including a clear and concise description of the expected behaviour, the actual behavior and the context in which you encountered it (ideally include details of your environment).
 
 ## Steps To Reproduce
 Steps to reproduce the behavior:

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/actions/install_requirements/action.yml

@@ -15,7 +15,8 @@ runs:
       run: |
         PYTHON_VERSION="${{ inputs.python-version }}"
         if [ $PYTHON_VERSION == "dev" ]; then
-          PYTHON_VERSION=$(sed -n "s/ARG PYTHON_VERSION=//p" Dockerfile)
+          # python version from Dockerfile, removing potential pinned sha
+          PYTHON_VERSION=$(sed -Ene "s/ARG PYTHON_VERSION=([0-9\.]+).*/\1/p" Dockerfile)
         fi
         echo "PYTHON_VERSION=$PYTHON_VERSION" >> "$GITHUB_ENV"
       shell: bash

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/dependabot.yml

@@ -1,8 +1,3 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
 version: 2
 updates:
   - package-ecosystem: "github-actions"
@@ -13,6 +8,8 @@ updates:
       actions:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"
 
   - package-ecosystem: "pip"
     directory: "/"
@@ -22,3 +19,8 @@ updates:
       dev-dependencies:
         patterns:
           - "*"
+    commit-message:
+      prefix: "chore"
+    ignore:
+      - dependency-name: "pyright"
+        versions: [ ">=1.1.407" ]  # Until https://github.com/microsoft/pyright/issues/11060 is fixed

mx_bluesky-1.5.12/.github/release.yml

@@ -0,0 +1,44 @@
+# .github/release.yml
+
+changelog:
+  categories:
+    - title: Hyperion
+      labels:
+        - hyperion
+    - title: Jungfrau
+      labels:
+        - jungfrau
+    - title: Murko
+      labels:
+        - murko
+    - title: I03
+      labels:
+        - i03
+    - title: I04
+      labels:
+        - i04
+    - title: I04-1
+      labels:
+        - i04-1
+    - title: I23
+      labels:
+        - i23
+    - title: I24
+      labels:
+        - i24
+    - title: VMXm
+      labels:
+        - vmxm
+    - title: VMXi
+      labels:
+        - vmxi
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Dev Experience / Refactors
+      labels:
+        - dev experience
+        - refactor
+    - title: Other Changes
+      labels:
+        - "*"

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/workflows/_container.yml

@@ -1,5 +1,9 @@
 on:
   workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
 
 jobs:
   build:
@@ -24,6 +28,10 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+      ################################
+      # Hyperion Container Image Build 
+      ################################
+
       - name: Build and export to Docker local cache
         uses: docker/build-push-action@v6
         env:
@@ -33,15 +41,6 @@ jobs:
           file: Dockerfile.hyperion
           load: true
 
-      - name: Build and export Dockerfile.blueapi to local cache
-        uses: docker/build-push-action@v6
-        env:
-          DOCKER_BUILD_RECORD_UPLOAD: false
-        with:
-          context: .
-          file: Dockerfile.blueapi
-          load: true
-
       - name: Create tags for publishing Hyperion image
         id: meta-hyperion
         uses: docker/metadata-action@v5
@@ -58,6 +57,45 @@ jobs:
             type=ref,event=tag
             type=raw,value=latest
 
+      - name: Push cached Hyperion image to container registry
+        if: inputs.publish && github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        # This does not build the image again, it will find the image in the
+        # Docker cache and publish it
+        with:
+          context: .
+          file: Dockerfile.hyperion
+          push: true
+          tags: ${{ steps.meta-hyperion.outputs.tags }}
+          labels: ${{ steps.meta-hyperion.outputs.labels }}
+          # Set the annotations to make the description appear in the GH repo page
+          annotations: ${{ steps.meta-hyperion.outputs.annotations }}
+
+      - name: Check disk space before
+        run: df  -h && docker buildx du
+
+      - name: Prune local image cache before next build
+        run: docker buildx prune -f
+
+      - name: Check disk space after
+        run: df  -h && docker buildx du
+
+      ###############################
+      # BlueAPI Container Image Build
+      ###############################
+
+      - name: Build and export Dockerfile.blueapi to local cache
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          file: Dockerfile.blueapi
+          load: true
+
+
       - name: Create tags for publishing BlueAPI image
         id: meta-blueapi
         uses: docker/metadata-action@v5
@@ -74,22 +112,6 @@ jobs:
             type=ref,event=tag
             type=raw,value=latest
 
-      - name: Push cached Hyperion image to container registry
-        if: github.ref_type == 'tag'
-        uses: docker/build-push-action@v6
-        env:
-          DOCKER_BUILD_RECORD_UPLOAD: false
-        # This does not build the image again, it will find the image in the
-        # Docker cache and publish it
-        with:
-          context: .
-          file: Dockerfile.hyperion
-          push: true
-          tags: ${{ steps.meta-hyperion.outputs.tags }}
-          labels: ${{ steps.meta-hyperion.outputs.labels }}
-          # Set the annotations to make the description appear in the GH repo page
-          annotations: ${{ steps.meta-hyperion.outputs.annotations }}
-
       - name: Push cached BlueAPI image to container registry
         if: github.ref_type == 'tag'
         uses: docker/build-push-action@v6

mx_bluesky-1.5.12/.github/workflows/_debug_container.yml

@@ -0,0 +1,49 @@
+on:
+  workflow_call:
+    inputs:
+      publish:
+        type: boolean
+        description: If true, pushes image to container registry
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Docker Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create tags for publishing debug image
+        id: debug-meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag,suffix=-debug
+            type=raw,value=latest-debug
+
+      - name: Build and publish debug image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          push: true
+          target: debug
+          tags: ${{ steps.debug-meta.outputs.tags }}

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/workflows/_docs.yml

@@ -1,6 +1,7 @@
 on:
   workflow_call:
 
+
 jobs:
   build:
     runs-on: ubuntu-latest

mx_bluesky-1.5.12/.github/workflows/_label.yml

@@ -0,0 +1,19 @@
+on:
+  workflow_call:
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: mheap/github-action-required-labels@v5
+        with:
+          labels: |
+            .*
+          use_regex: true
+          mode: minimum
+          count: 1
+          add_comment: true
+          message: "Please add a label to this PR. This helps with generating helpful release notes."

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@e7a8f85e1c67a31e6ed99a94b41bd0b71bbee6b8 # v2.0.9
+        uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/workflows/_test.yml

@@ -56,7 +56,7 @@ jobs:
         run: tox -e tests -- -m "not dlstbx" --timeout=2 --cov=mx_bluesky --cov-report term --cov-report xml:cov.xml
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
           files: cov.xml

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.github/workflows/ci.yml

@@ -2,26 +2,32 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
+    tags:
+      - '*'
   pull_request:
 
 jobs:
-  check:
-    uses: ./.github/workflows/_check.yml
+
+  require-label:
+    if: github.event_name == 'pull_request'
+    uses: ./.github/workflows/_label.yml
 
   lint:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_tox.yml
     with:
       tox: pre-commit,type-checking
 
   test:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     strategy:
       matrix:
         runs-on: ["ubuntu-latest"] # can add windows-latest, macos-latest
-        python-version: ["3.11", "3.12"]
+        python-version: ["3.11", "3.12", "3.13"]
+        include:
+          # Include one that runs in the dev environment
+          - runs-on: "ubuntu-latest"
+            python-version: "dev"
       fail-fast: false
     uses: ./.github/workflows/_test.yml
     with:
@@ -31,9 +37,20 @@ jobs:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   container:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
+    needs: test
+    if: always()
     uses: ./.github/workflows/_container.yml
+    with:
+      publish: ${{ needs.test.result == 'success' }}
+    permissions:
+      contents: read
+      packages: write
+
+  debug_container:
+    needs: [container, test]
+    uses: ./.github/workflows/_debug_container.yml
+    with:
+      publish: ${{ needs.test.result == 'success' }}
     permissions:
       contents: read
       packages: write
@@ -47,25 +64,22 @@ jobs:
       packages: write
 
   docs:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_docs.yml
 
+
   dist:
-    needs: check
-    if: needs.check.outputs.branch-pr == ''
     uses: ./.github/workflows/_dist.yml
   
   pypi:
+    needs: [dist, test]
     if: github.ref_type == 'tag'
-    needs: dist
     uses: ./.github/workflows/_pypi.yml
     permissions:
       id-token: write
   
   release:
+    needs: [dist, test, docs]
     if: github.ref_type == 'tag'
-    needs: [dist, docs]
     uses: ./.github/workflows/_release.yml
     permissions:
       contents: write

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=500"]
@@ -15,7 +15,7 @@ repos:
       - id: ruff
         name: lint with ruff
         language: system
-        entry: ruff check --force-exclude
+        entry: ruff check --force-exclude --fix
         types: [python]
         require_serial: true
 

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.vscode/extensions.json

@@ -5,6 +5,7 @@
         "tamasfe.even-better-toml",
         "redhat.vscode-yaml",
         "ryanluker.vscode-coverage-gutters",
-        "charliermarsh.Ruff"
+        "charliermarsh.Ruff",
+        "streetsidesoftware.code-spell-checker"
     ]
 }

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.vscode/launch.json

@@ -17,7 +17,7 @@
             "env": {
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
                 "PYTEST_RAISE": "1",
-                "PYTEST_ADDOPTS": "--no-cov"
+                "PYTEST_ADDOPTS": "--no-cov" // Needed for debugger - see https://code.visualstudio.com/docs/python/testing#_pytest-configuration-settings
             },
         }
     ]

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.vscode/mx-bluesky.code-workspace

@@ -18,6 +18,6 @@
         ],
         "python.analysis.autoImportCompletions": true,
         "terminal.integrated.gpuAcceleration": "off",
-        "esbonio.sphinx.confDir": ""
+        "esbonio.sphinx.confDir": "",
     }
 }

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/.vscode/settings.json

@@ -24,4 +24,36 @@
     },
     "terminal.integrated.gpuAcceleration": "off",
     "python.analysis.typeCheckingMode": "basic",
+    "cSpell.words": [
+        "aperturescatterguard",
+        "beamline",
+        "beamlines",
+        "beamsize",
+        "beamstop",
+        "blueapi",
+        "caget",
+        "cryostream",
+        "deadtime",
+        "dodal",
+        "eiger",
+        "Expeye",
+        "fastcs",
+        "flyscan",
+        "gonio",
+        "gridscan",
+        "mrad",
+        "murko",
+        "ophyd",
+        "pmac",
+        "readback",
+        "scanspec",
+        "scatterguard",
+        "smargon",
+        "thawer",
+        "topup",
+        "Transfocator",
+        "undulator",
+        "xbpm",
+        "xspress"
+    ],
 }

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/Dockerfile

@@ -17,10 +17,33 @@ ENV PATH=/venv/bin:$PATH
 
 # The build stage installs the context into the venv
 FROM developer AS build
-COPY . /context
-WORKDIR /context
+# Requires buildkit 0.17.0
+COPY --chmod=o+wrX . /workspaces/mx-bluesky
+WORKDIR /workspaces/mx-bluesky
 RUN touch dev-requirements.txt && pip install -c dev-requirements.txt .
 
+
+FROM build AS debug
+
+
+# Set origin to use ssh
+RUN git remote set-url origin git@github.com:DiamondLightSource/mx-bluesky.git
+
+
+# For this pod to understand finding user information from LDAP
+RUN apt update
+RUN DEBIAN_FRONTEND=noninteractive apt install libnss-ldapd -y
+RUN sed -i 's/files/ldap files/g' /etc/nsswitch.conf
+
+# Make editable and debuggable
+RUN pip install debugpy
+RUN pip install -e .
+
+# Alternate entrypoint to allow devcontainer to attach
+ENTRYPOINT [ "/bin/bash", "-c", "--" ]
+CMD [ "while true; do sleep 30; done;" ]
+
+
 # The runtime stage copies the built venv into a slim runtime container
 FROM python:${PYTHON_VERSION}-slim AS runtime
 # Add apt-get system dependecies for runtime here if needed

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/Dockerfile.blueapi

@@ -5,11 +5,13 @@ FROM ghcr.io/diamondlightsource/blueapi:1.0.0-rc.2
 
 ARG DEBIAN_FRONTEND=noninteractive
 
-RUN apt update -y && apt upgrade -y
-# Needed for python cv2 dependency
-RUN apt install -y libgl1 libglib2.0-0
+# Need:
+# libgl, libglib2.0 for python cv2 dependency 
+RUN apt update -y && \
+    apt upgrade -y && \
+    apt install -y libgl1 libglib2.0-0
 
-RUN /venv/bin/pip install mx-bluesky
+RUN /venv/bin/pip install --no-cache-dir --no-compile mx-bluesky
 
 # Needed so that Blueapi's setup-scratch stage has permission to modify dependencies installed 
 # in the above pip installation

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/Dockerfile.hyperion

@@ -2,11 +2,13 @@ FROM python:3.11 AS build
 
 ARG DEBIAN_FRONTEND=noninteractive
 
-RUN apt update -y && apt upgrade -y
-# Needed for python cv2 dependency
-RUN apt install -y libgl1 libglib2.0-0
+# Need:
+# libgl, libglib2.0 for python cv2 dependency
+RUN apt update -y && \
+    apt upgrade -y && \
+    apt install -y libgl1 libglib2.0-0
 
-RUN pip install setuptools_scm
+RUN pip install --no-cache-dir --no-compile setuptools_scm
 
 # Copy the pyproject.toml and install dependencies for better caching when developing
 # & rerunning deployment scripts

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mx-bluesky
-Version: 1.5.10
+Version: 1.5.12
 Summary: Bluesky tools for MX Beamlines at DLS
 Author-email: Dominic Oram <dominic.oram@diamond.ac.uk>
 License:                                  Apache License
@@ -210,6 +210,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
@@ -217,11 +218,10 @@ Requires-Dist: annotated_types
 Requires-Dist: caproto
 Requires-Dist: fastapi[all]
 Requires-Dist: flask-restful
-Requires-Dist: ispyb
 Requires-Dist: jupyterlab
 Requires-Dist: matplotlib
 Requires-Dist: nexgen>=0.11.0
-Requires-Dist: numpy==2.2.6
+Requires-Dist: numpy>=2.3.5
 Requires-Dist: opencv-python
 Requires-Dist: opentelemetry-distro
 Requires-Dist: opentelemetry-exporter-otlp
@@ -237,17 +237,18 @@ Requires-Dist: deepdiff
 Requires-Dist: matplotlib
 Requires-Dist: cachetools
 Requires-Dist: daq-config-server>=v1.0.0-rc.2
-Requires-Dist: blueapi>=1.5.0
+Requires-Dist: blueapi>=1.6.3
 Requires-Dist: ophyd>=1.10.5
-Requires-Dist: ophyd-async>=0.10.0a2
+Requires-Dist: ophyd-async>=0.14.0
 Requires-Dist: bluesky>=1.14.6
-Requires-Dist: dls-dodal==1.63.0
+Requires-Dist: dls-dodal==1.66.0
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: diff-cover; extra == "dev"
 Requires-Dist: GitPython; extra == "dev"
 Requires-Dist: import-linter; extra == "dev"
+Requires-Dist: ispyb; extra == "dev"
 Requires-Dist: ipython; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: myst-parser; extra == "dev"
@@ -255,12 +256,13 @@ Requires-Dist: pipdeptree; extra == "dev"
 Requires-Dist: plantweb; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pydata-sphinx-theme>=0.12; extra == "dev"
-Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pyright==1.1.406; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-random-order; extra == "dev"
 Requires-Dist: pytest-timeout; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: responses; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: sphinx-autobuild; extra == "dev"
 Requires-Dist: sphinx-copybutton; extra == "dev"

{mx_bluesky-1.5.10 → mx_bluesky-1.5.12}/conftest.py

@@ -7,6 +7,9 @@ import pytest
 environ["HYPERION_TEST_MODE"] = "true"
 
 
+pytest_plugins = ["dodal.testing.fixtures.run_engine"]
+
+
 def pytest_addoption(parser):
     parser.addoption(
         "--logging",