Update repository to match Bluesky standards

.gitattributes

@@ -1 +1,3 @@
 bluesky_queueserver/_version.py export-subst
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.github/workflows/docs.yml

@@ -5,33 +5,36 @@ on: [push, pull_request]
 jobs:
   build:
 
+    name: Test building docs
+
     runs-on: ubuntu-latest
+
+    env:
+      python_env: py313
+
     strategy:
-      matrix:
-        python-version: ['3.12']
       fail-fast: false
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: shogo82148/actions-setup-redis@v1
-      with:
-        redis-version: "7.x"
-    - name: Install dependencies
-      run: |
-        # sudo apt install redis
-
-        # These packages are installed in the base environment but may be older
-        # versions. Explicitly upgrade them because they often create
-        # installation problems if out of date.
-        python -m pip install --upgrade pip setuptools numpy
-
-        pip install .
-        pip install -r requirements-dev.txt
-        pip list
-    - name: Build Docs
-      run: |
-        make -C docs/ html
+      - uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - uses: shogo82148/actions-setup-redis@v1
+        with:
+          redis-version: "7.x"
+
+      - uses: prefix-dev/setup-pixi@v0.10.0
+
+      - name: Install dev dependencies
+        run: |
+          set -vxeuo pipefail
+          pixi install --environment=${{ env.python_env }}
+          pixi list --environment=${{ env.python_env }}
+          pixi run --environment=${{ env.python_env }} pip list
+          pixi run --environment=${{ env.python_env }} conda list
+
+      - name: Run pre-commit
+        run: |
+          pixi run --environment=${{ env.python_env }} make -C docs/ html

.github/workflows/docs_publish.yml

@@ -1,4 +1,4 @@
-name: Publish Docs
+name: Documentation
 
 on:
   push:
@@ -8,51 +8,50 @@ on:
 jobs:
   build:
     if: github.repository_owner == 'bluesky'
+
+    name: Build and publish docs
+
     runs-on: ubuntu-latest
+
+    env:
+      python_env: py313
+
     strategy:
-      matrix:
-        python-version: ['3.12']
       fail-fast: false
 
     steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1000  # should be enough to reach the most recent tag
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: shogo82148/actions-setup-redis@v1
-      with:
-        redis-version: "7.x"
-    - name: Install dependencies
-      run: |
-        # sudo apt install redis
-
-        # Versioneer uses the most recent git tag to generate __version__, which appears
-        # in the published documentation.
-        git fetch --tags
-
-        # These packages are installed in the base environment but may be older
-        # versions. Explicitly upgrade them because they often create
-        # installation problems if out of date.
-        python -m pip install --upgrade pip setuptools numpy
-
-        pip install .
-        pip install -r requirements-dev.txt
-        pip list
-    - name: Build Docs
-      run: |
-        make -C docs/ html
-    - name: Deploy documentation to blueskyproject.io
-      # We pin to the SHA, not the tag, for security reasons.
-      # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-      uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
-      with:
-        deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
-        publish_branch: master
-        publish_dir: ./docs/build/html
-        external_repository: bluesky/bluesky.github.io
-        destination_dir: bluesky-queueserver
-        keep_files: true  # Keep old files.
-        force_orphan: false  # Keep git history.
+      - uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - uses: shogo82148/actions-setup-redis@v1
+        with:
+          redis-version: "7.x"
+
+      - uses: prefix-dev/setup-pixi@v0.10.0
+
+      - name: Install dev dependencies
+        run: |
+          set -vxeuo pipefail
+          pixi install --environment=${{ env.python_env }}
+          pixi list --environment=${{ env.python_env }}
+          pixi run --environment=${{ env.python_env }} pip list
+          pixi run --environment=${{ env.python_env }} conda list
+
+      - name: Run pre-commit
+        run: |
+          pixi run --environment=${{ env.python_env }} make -C docs/ html
+
+      - name: Deploy documentation to blueskyproject.io
+        # We pin to the SHA, not the tag, for security reasons.
+        # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
+        uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
+          publish_branch: master
+          publish_dir: ./docs/build/html
+          external_repository: bluesky/bluesky.github.io
+          destination_dir: bluesky-queueserver
+          keep_files: true  # Keep old files.
+          force_orphan: false  # Keep git history.

.github/workflows/pre-commit.yml

@@ -11,23 +11,35 @@ jobs:
     if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
 
     name: Check code style
+
     runs-on: ubuntu-latest
+
+    env:
+      python_env: py313
+
     strategy:
       fail-fast: false
+
     defaults:
       run:
         shell: bash -l {0}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
 
-      - uses: actions/setup-python@v4
+      - uses: prefix-dev/setup-pixi@v0.10.0
 
       - name: Install dev dependencies
         run: |
           set -vxeuo pipefail
-          pip install -r requirements-dev.txt
-          python -m pip list
+          pixi install --environment=${{ env.python_env }}
+          pixi list --environment=${{ env.python_env }}
+          pixi run --environment=${{ env.python_env }} pip list
+          pixi run --environment=${{ env.python_env }} conda list
 
       - name: Run pre-commit
-        run: pre-commit run --all-files
+        run: |
+          pixi run --environment=${{ env.python_env }} pre-commit run --all-files

.github/workflows/pypi.yml

@@ -0,0 +1,55 @@
+name: Publish the release to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+
+    name: Upload to PyPI
+
+    if: github.repository_owner == 'bluesky'
+    runs-on: ubuntu-latest
+
+    env:
+      python_env: py313
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - uses: prefix-dev/setup-pixi@v0.10.0
+
+      - name: Install dev dependencies
+        run: |
+          set -vxeuo pipefail
+          pixi install --environment=${{ env.python_env }}
+          pixi list --environment=${{ env.python_env }}
+          pixi run --environment=${{ env.python_env }} pip list
+          pixi run --environment=${{ env.python_env }} conda list
+
+      - name: Build sdist and wheel
+        run: >
+          export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) &&
+          pixi run --environment=${{ env.python_env }} python -m build
+
+      - name: Check for packaging errors
+        run: pixi run --environment=${{ env.python_env }} twine check --strict dist/*
+
+      - name: Install produced wheel
+        run: pixi run --environment=${{ env.python_env }} pip install dist/*.whl
+
+      - name: Test module is importable using the installed wheel
+        # If more than one module in src/ replace with module name to test
+        run: pixi run --environment=${{ env.python_env }} python -c "import $(ls --hide='*.egg-info' src | head -1)"
+
+      - name: Publish to PyPI using trusted publishing
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: false