bec-slurm-manager 1.0.1__tar.gz

bec_slurm_manager-1.0.1/.env.example

@@ -0,0 +1,5 @@
+SLURM_REST_URL=https://ra-slurmapi-001.psi.ch
+SLURM_REST_API_VERSION=v0.0.44
+SLURM_JWT=
+# Optional: only set if required by your Slurm authentication configuration.
+# SLURM_USER=your_username

bec_slurm_manager-1.0.1/.github/workflows/check_pr.yml

@@ -0,0 +1,28 @@
+name: Check PR status for branch
+on:
+  workflow_call:
+    outputs:
+      branch-pr:
+        description: The PR number if the branch is in one
+        value: ${{ jobs.pr.outputs.branch-pr }}
+
+jobs:
+  pr:
+    runs-on: "ubuntu-latest"
+    outputs:
+      branch-pr: ${{ steps.script.outputs.result }}
+    steps:
+      - uses: actions/github-script@v7
+        id: script
+        if: github.event_name == 'push'
+        with:
+          script: |
+            const prs = await github.rest.pulls.list({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              head: context.repo.owner + ':${{ github.ref_name }}'
+            })
+            if (prs.data.length) {
+              console.log(`::notice ::Skipping CI on branch push as it is already run in PR #${prs.data[0]["number"]}`)
+              return prs.data[0]["number"]
+            }

bec_slurm_manager-1.0.1/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: Full CI
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  pull-requests: write
+
+jobs:
+  check_pr_status:
+    uses: ./.github/workflows/check_pr.yml
+
+  formatter:
+    needs: check_pr_status
+    if: needs.check_pr_status.outputs.branch-pr == ''
+    uses: ./.github/workflows/formatter.yml
+
+  unit_tests:
+    needs: check_pr_status
+    if: needs.check_pr_status.outputs.branch-pr == ''
+    uses: ./.github/workflows/unit_tests.yml
+
+  go_worker:
+    needs: check_pr_status
+    if: needs.check_pr_status.outputs.branch-pr == ''
+    uses: ./.github/workflows/go_worker.yml
+
+  publish_worker:
+    needs: [formatter, unit_tests, go_worker]
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      actions: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/download-artifact@v4
+        with:
+          name: bec-slurm-worker-packages
+          path: worker/dist
+      - name: Publish Linux archives and RPMs to Gitea
+        env:
+          GITEA_REGISTRY_TOKEN: ${{ secrets.GITEA_REGISTRY_TOKEN }}
+        run: bash worker/scripts/upload-packages.sh "${GITHUB_REF_NAME#v}"

bec_slurm_manager-1.0.1/.github/workflows/formatter.yml

@@ -0,0 +1,16 @@
+name: Ruff
+on: [workflow_call]
+jobs:
+  Ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: python -m pip install -e '.[dev]'
+      - name: Check imports and lint
+        run: ruff check .
+      - name: Check formatting
+        run: ruff format --check .

bec_slurm_manager-1.0.1/.github/workflows/go_worker.yml

@@ -0,0 +1,48 @@
+name: Go worker
+on: [workflow_call]
+jobs:
+  worker:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: worker
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v6
+        with:
+          go-version-file: worker/go.mod
+          cache-dependency-path: worker/go.sum
+      - name: Check formatting
+        run: test -z "$(gofmt -l .)"
+      - name: Test and vet
+        run: make test
+      - uses: goreleaser/goreleaser-action@v7
+        with:
+          distribution: goreleaser
+          version: v2.18.0
+          install-only: true
+      - name: Select package version
+        shell: bash
+        run: |
+          if [[ "$GITHUB_REF" == refs/tags/v* ]]; then
+            version="${GITHUB_REF_NAME#v}"
+          else
+            version="0.0.0-dev.${GITHUB_RUN_NUMBER}.g${GITHUB_SHA:0:12}"
+          fi
+          if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$ ]]; then
+            echo 'Expected a semantic version after the v tag prefix.' >&2
+            exit 1
+          fi
+          printf 'BUILD_VERSION=%s\n' "$version" >> "$GITHUB_ENV"
+      - name: Build Linux archives and RPMs
+        run: make package VERSION="$BUILD_VERSION"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: bec-slurm-worker-packages
+          if-no-files-found: error
+          path: |
+            worker/dist/*.tar.gz
+            worker/dist/*.rpm
+            worker/dist/checksums.txt

bec_slurm_manager-1.0.1/.github/workflows/semantic_release.yml

@@ -0,0 +1,93 @@
+name: Continuous Delivery
+
+on:
+  push:
+    branches:
+      - main
+
+# default: least privileged permissions across all jobs
+permissions:
+  contents: read
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+
+    permissions:
+      contents: write
+
+    steps:
+      # Note: We checkout the repository at the branch that triggered the workflow
+      # with the entire history to ensure to match PSR's release branch detection
+      # and history evaluation.
+      # However, we forcefully reset the branch to the workflow sha because it is
+      # possible that the branch was updated while the workflow was running. This
+      # prevents accidentally releasing un-evaluated changes.
+      - name: Setup | Checkout Repository on Release Branch
+        uses: actions/checkout@v6
+        with:
+          ref: ${{ github.ref_name }}
+          fetch-depth: 0
+          ssh-key: ${{ secrets.CI_DEPLOY_SSH_KEY }}
+          ssh-known-hosts: ${{ secrets.CI_DEPLOY_SSH_KNOWN_HOSTS }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Setup | Force release branch to be at workflow sha
+        run: |
+          git reset --hard ${{ github.sha }}
+      - name: Evaluate | Verify upstream has NOT changed
+        # Last chance to abort before causing an error as another PR/push was applied to
+        # the upstream branch while this workflow was running. This is important
+        # because we are committing a version change (--commit). You may omit this step
+        # if you have 'commit: false' in your configuration.
+        shell: bash
+        run: |
+          set +o pipefail
+
+          UPSTREAM_BRANCH_NAME="$(git status -sb | head -n 1 | cut -d' ' -f2 | grep -E '\.{3}' | cut -d'.' -f4)"
+          printf '%s\n' "Upstream branch name: $UPSTREAM_BRANCH_NAME"
+
+          set -o pipefail
+
+          if [ -z "$UPSTREAM_BRANCH_NAME" ]; then
+              printf >&2 '%s\n' "::error::Unable to determine upstream branch name!"
+              exit 1
+          fi
+
+          git fetch "${UPSTREAM_BRANCH_NAME%%/*}"
+
+          if ! UPSTREAM_SHA="$(git rev-parse "$UPSTREAM_BRANCH_NAME")"; then
+              printf >&2 '%s\n' "::error::Unable to determine upstream branch sha!"
+              exit 1
+          fi
+
+          HEAD_SHA="$(git rev-parse HEAD)"
+
+          if [ "$HEAD_SHA" != "$UPSTREAM_SHA" ]; then
+              printf >&2 '%s\n' "[HEAD SHA] $HEAD_SHA != $UPSTREAM_SHA [UPSTREAM SHA]"
+              printf >&2 '%s\n' "::error::Upstream has changed, aborting release..."
+              exit 1
+          fi
+
+          printf '%s\n' "Verified upstream branch has not changed, continuing with release..."
+
+      - name: Semantic Version Release
+        id: release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.CI_PYPI_TOKEN }}
+        run: |
+          python -m pip install "python-semantic-release==9.*" wheel build twine
+          semantic-release -vv version
+          if [ ! -d dist ]; then echo No release will be made; exit 0; fi
+          twine check dist/*
+          twine upload --verbose dist/* --skip-existing
+          semantic-release publish

bec_slurm_manager-1.0.1/.github/workflows/unit_tests.yml

@@ -0,0 +1,18 @@
+name: Unit tests
+on: [workflow_call]
+jobs:
+  UnitTests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: python -m pip install -e '.[dev]'
+      - name: Run unit tests
+        run: python -m pytest --random-order -q test

bec_slurm_manager-1.0.1/.gitignore

@@ -0,0 +1,208 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+*venv/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

bec_slurm_manager-1.0.1/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

bec_slurm_manager-1.0.1/CHANGELOG.md

@@ -0,0 +1,146 @@
+# CHANGELOG
+
+
+## v1.0.1 (2026-10-28)
+
+### Bug Fixes
+
+- Rename PyPI distribution to bec-slurm-manager
+  ([`f34a4a5`](https://github.com/bec-project/slurm_manager/commit/f34a4a5e22d84de405b1a6f657a1817c8b8fe68f))
+
+### Documentation
+
+- Use BEC Slurm Manager as README title
+  ([`71d00c9`](https://github.com/bec-project/slurm_manager/commit/71d00c972b0791d315f900fb8ff4f68435820532))
+
+### Testing
+
+- Add opt-in RA lifecycle and module smoke tests
+  ([`19971ef`](https://github.com/bec-project/slurm_manager/commit/19971ef8a9157ab3a249c5aba8d84165af08b19e))
+
+
+## v1.0.0 (2026-10-28)
+
+### Bug Fixes
+
+- Apply manager listeners to current and future jobs
+  ([`cb82628`](https://github.com/bec-project/slurm_manager/commit/cb8262809f98c797e896fe5b9bfc1b90e6df8343))
+
+- Dispatch terminal statuses and log callback failures
+  ([`8bc0149`](https://github.com/bec-project/slurm_manager/commit/8bc0149b3569c8ba284eca0619b215bab9b7bd2a))
+
+- **ci**: Validate worker bundles and resume package uploads
+  ([`9b8ca5e`](https://github.com/bec-project/slurm_manager/commit/9b8ca5eed8ffdd87d12dd49e10294713e9d91d7f))
+
+- **worker**: Honor cancellation grace for child processes
+  ([`c46a8f8`](https://github.com/bec-project/slurm_manager/commit/c46a8f81080b8d76b6c9b67a413cdee9b76af1c5))
+
+### Continuous Integration
+
+- Test and build the Go worker
+  ([`6fa1d30`](https://github.com/bec-project/slurm_manager/commit/6fa1d30b47ef6c344b0666431b94acb72762e066))
+
+- Validate distributions and show PyPI upload errors
+  ([`1779368`](https://github.com/bec-project/slurm_manager/commit/177936846f53461bcf84e643cf58c4fa4ecbf340))
+
+### Documentation
+
+- Add job submission examples and project icon
+  ([`aa01055`](https://github.com/bec-project/slurm_manager/commit/aa010550e77578c6fc07e5dd67659edaf75671f1))
+
+- Preserve line breaks in live log example
+  ([`97e731d`](https://github.com/bec-project/slurm_manager/commit/97e731d6cb3337ca5367403bccaa933a7f16c0cd))
+
+### Features
+
+- Package bec-slurm-worker for Linux and RPM deployment
+  ([`4477cc1`](https://github.com/bec-project/slurm_manager/commit/4477cc11be1ac8ff5069cbb931d334bca074b92e))
+
+- Submit Slurm jobs through REST and track execution
+  ([`4d17ce9`](https://github.com/bec-project/slurm_manager/commit/4d17ce9d548075f60eb466ae9227e9a9da12a397))
+
+- **worker**: Add standalone Go job runner
+  ([`790ca5b`](https://github.com/bec-project/slurm_manager/commit/790ca5b396ed3d2362b7e384911b6fd71d4821de))
+
+
+## v0.1.0 (2026-10-28)
+
+### Bug Fixes
+
+- Address Slurm job monitoring and subscription review findings
+  ([`afcf5fb`](https://github.com/bec-project/slurm_manager/commit/afcf5fbe65c5293ed60a129cc5e4eba2eb04d492))
+
+- Cleanup
+  ([`b44b216`](https://github.com/bec-project/slurm_manager/commit/b44b21661214574d9c6351e89c9a02722f961cc1))
+
+- Fix vscode settings and formatting
+  ([`3db18d6`](https://github.com/bec-project/slurm_manager/commit/3db18d6583bfdbed1c518a3ed71cf0707bed3b47))
+
+- Formatting
+  ([`b9ad35a`](https://github.com/bec-project/slurm_manager/commit/b9ad35a51d5895cddc63b5bac790aa5e2e2163d2))
+
+- Route clustered jobs and serialize callback registration
+  ([`24a8fa8`](https://github.com/bec-project/slurm_manager/commit/24a8fa889458ace13b80191bb088db3181a9e6d2))
+
+### Chores
+
+- Add .gitignore file with common Python ignores
+  ([`2ebc5f2`](https://github.com/bec-project/slurm_manager/commit/2ebc5f273d746d130404e05a3038a11037f2e1a2))
+
+- Add venv to gitignore
+  ([`0f3e1e0`](https://github.com/bec-project/slurm_manager/commit/0f3e1e0e40e22935a6761ddeacc16af770649930))
+
+### Continuous Integration
+
+- Add ci actions
+  ([`fd54d2b`](https://github.com/bec-project/slurm_manager/commit/fd54d2b1a8ea88b80e1a8723c6bf4d2071babb1d))
+
+- Add semantic release workflow
+  ([`36c858a`](https://github.com/bec-project/slurm_manager/commit/36c858aa43baffad0ccaac79a78627606629f0f2))
+
+Closes #5.
+
+- Separate unit tests and cover Python 3.12 through 3.14
+  ([`63c58ce`](https://github.com/bec-project/slurm_manager/commit/63c58ce824c87fe127d13c85b24a9782e47da5be))
+
+### Features
+
+- Add redis_pubsub_client
+  ([`b685051`](https://github.com/bec-project/slurm_manager/commit/b685051d8cc01f540191073fd209565fbbd643f7))
+
+- Bash wrapper for job
+  ([`4ef8646`](https://github.com/bec-project/slurm_manager/commit/4ef8646ca775d4ce5137805ada38f3082d3b4129))
+
+- Initial commit
+  ([`0b9782d`](https://github.com/bec-project/slurm_manager/commit/0b9782d751218cf3abe3f7247a4251b385c14fad))
+
+- Slurmmanager, JobFuture and RedisSubClient initial implementation
+  ([`0164768`](https://github.com/bec-project/slurm_manager/commit/01647688e93acb1bbd0baa306ae8d081c68eb4a6))
+
+- **job-future**: Add JobFuture implementation for monitoring running slurm jobs.
+  ([`aa863c8`](https://github.com/bec-project/slurm_manager/commit/aa863c80f3b6272cfd638deef8fa467ffe48b727))
+
+- **slurm-manager**: First imlementation of SlurmManager
+  ([`3019d6e`](https://github.com/bec-project/slurm_manager/commit/3019d6e50534781ee3585e27cf3922da09121574))
+
+### Refactoring
+
+- Add slurm job id to SubscriptionInfo and to metadata
+  ([`aa2b3e5`](https://github.com/bec-project/slurm_manager/commit/aa2b3e5389ff0254e6f7248dc9c04f2071d9e039))
+
+- Address PR comments
+  ([`5d7b9d4`](https://github.com/bec-project/slurm_manager/commit/5d7b9d4034c98f3b6a2e7781ea1895ef5012a521))
+
+- Fix pyproject and add readme
+  ([`bb6e43f`](https://github.com/bec-project/slurm_manager/commit/bb6e43fe7473ee4981f8966c3083519a6b3f8ae6))
+
+- Simplify redis_worker.sh and use jq for json bash parsing
+  ([`1685e88`](https://github.com/bec-project/slurm_manager/commit/1685e88a1af49de96969c1ddf624ed5f08125519))
+
+- **slurm-manager**: Refactor job_info to pydantic, and cleanup
+  ([`a64bb84`](https://github.com/bec-project/slurm_manager/commit/a64bb843b95516344e23fae5f48640bd86d299c2))
+
+### Testing
+
+- Fix test for test_redis_pubsub_client
+  ([`86d3a9e`](https://github.com/bec-project/slurm_manager/commit/86d3a9ee14234d1b80dcbae90dab1097930554ca))

bec_slurm_manager-1.0.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.5
+Name: bec-slurm-manager
+Version: 1.0.1
+Summary: A tool for managing slurm jobs.
+Project-URL: Bug Tracker, https://github.com/bec-project/slurm_manager/issues
+Project-URL: Homepage, https://github.com/bec-project/slurm_manager
+Project-URL: changelog, https://github.com/bec-project/slurm_manager/blob/main/CHANGELOG.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: pydantic~=2.12.0
+Requires-Dist: python-dotenv~=1.2
+Requires-Dist: redis[hiredis]<9.0,>=6.2
+Provides-Extra: dev
+Requires-Dist: coverage~=7.0; extra == 'dev'
+Requires-Dist: fakeredis>=2.23.2,~=2.23; extra == 'dev'
+Requires-Dist: pytest-random-order~=1.1; extra == 'dev'
+Requires-Dist: pytest~=8.0; extra == 'dev'
+Requires-Dist: ruff~=0.17.1; extra == 'dev'