bec-launcher 0.1.0__tar.gz

bec_launcher-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,41 @@
+name: Bug report
+description: File a bug report.
+title: "[BUG]: "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Bug report:
+  - type: textarea
+    id: description
+    attributes:
+      label: Provide a brief description of the bug.
+  - type: textarea
+    id: expected
+    attributes:
+      label: Describe what you expected to happen and what actually happened.
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.
+  - type: input
+    id: version
+    attributes:
+      label: bec_widgets version
+      description: which version of BEC widgets was running?
+  - type: input
+    id: bec-version
+    attributes:
+      label: bec core version
+      description: which version of BEC core was running?
+  - type: textarea
+    id: extra
+    attributes:
+      label: Any extra info / data? e.g. log output...
+  - type: input
+    id: issues
+    attributes:
+      label: Related issues
+      description: please tag any related issues

bec_launcher-0.1.0/.github/ISSUE_TEMPLATE/documentation_update.md

@@ -0,0 +1,37 @@
+---
+name: Documentation update request
+about: Suggest an update to the docs
+title: '[DOCS]: '
+type: documentation
+label: documentation
+assignees: ''
+
+---
+
+## Documentation Section
+
+[Specify the section or page of the documentation that needs updating]
+
+## Current Information
+
+[Provide the current information in the documentation that needs to be updated]
+
+## Proposed Update
+
+[Describe the proposed update or correction. Be specific about the changes that need to be made]
+
+## Reason for Update
+
+[Explain the reason for the documentation update. Include any recent changes, new features, or corrections that necessitate the update]
+
+## Additional Context
+
+[Include any additional context or information that can help the documentation team understand the update better]
+
+## Attachments
+
+[Attach any files, screenshots, or references that can assist in making the documentation update]
+
+## Priority
+
+[Assign a priority level to the documentation update based on its urgency. Use a scale such as Low, Medium, High]

bec_launcher-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,49 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEAT]: '
+type: feature
+label: feature
+assignees: ''
+
+---
+
+## Feature Summary
+
+[Provide a brief and clear summary of the new feature you are requesting]
+
+## Problem Description
+
+[Explain the problem or need that this feature aims to address. Be specific about the issues or gaps in the current functionality]
+
+## Use Case
+
+[Describe a real-world scenario or use case where this feature would be beneficial. Explain how it would improve the user experience or workflow]
+
+## Proposed Solution
+
+[If you have a specific solution in mind, describe it here. Explain how it would work and how it would address the problem described above]
+
+## Benefits
+
+[Explain the benefits and advantages of implementing this feature. Highlight how it adds value to the product or improves user satisfaction]
+
+## Alternatives Considered
+
+[If you've considered alternative solutions or workarounds, mention them here. Explain why the proposed feature is the preferred option]
+
+## Impact on Existing Functionality
+
+[Discuss how the new feature might impact or interact with existing features. Address any potential conflicts or dependencies]
+
+## Priority
+
+[Assign a priority level to the feature request based on its importance. Use a scale such as Low, Medium, High]
+
+## Attachments
+
+[Include any relevant attachments, such as sketches, diagrams, or references that can help the development team understand your feature request better]
+
+## Additional Information
+
+[Provide any additional information that might be relevant to the feature request, such as user feedback, market trends, or similar features in other products]

bec_launcher-0.1.0/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,33 @@
+## Description
+
+[Provide a brief description of the changes introduced by this pull request.]
+
+## Related Issues
+
+[Cite any related issues or feature requests that are addressed or resolved by this pull request. Link the associated issue, for example, with `fixes #123` or `closes #123`.]
+
+## Type of Change
+
+- Change 1
+- Change 2
+
+## How to test
+
+- Run unit tests
+- Open [widget] in designer and play around with the properties
+
+## Potential side effects
+
+[Describe any potential side effects or risks of merging this PR.]
+
+## Screenshots / GIFs (if applicable)
+
+[Include any relevant screenshots or GIFs to showcase the changes made.]
+
+## Additional Comments
+
+[Add any additional comments or information that may be helpful for reviewers.]
+
+## Definition of Done
+- [ ] Documentation is up-to-date.
+

bec_launcher-0.1.0/.github/actions/bec_launcher_install/action.yml

@@ -0,0 +1,32 @@
+name: "BEC Launcher Install"
+description: "Install BEC Launcher and related os dependencies"
+inputs:
+  BEC_LAUNCHER_BRANCH: # id of input
+    required: false
+    default: "main"
+    description: "Branch of BEC Launcher to install"
+  PYTHON_VERSION: # id of input
+    required: false
+    default: "3.11"
+    description: "Python version to use"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.PYTHON_VERSION }}
+
+    - name: Checkout BEC Core
+      uses: actions/checkout@v4
+      with:
+        repository: bec-project/bec_launcher
+        ref: ${{ inputs.BEC_LAUNCHER_BRANCH }}
+        path: ./bec_launcher
+
+    - name: Install Python dependencies
+      shell: bash
+      run: |
+        pip install uv
+        uv pip install --system -e ./bec_launcher[dev]

bec_launcher-0.1.0/.github/workflows/add-issues.yml

@@ -0,0 +1,16 @@
+name: Add issues to the BEC project
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v1.0.2
+        with:
+          project-url: https://github.com/orgs/bec-project/projects/3
+          github-token: ${{ secrets.ADD_ISSUE_TO_PROJECT }}

bec_launcher-0.1.0/.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' && github.event.ref_type != 'tag'
+        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_launcher-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Full CI
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      BEC_LAUNCHER_BRANCH:
+        description: "Branch of BEC Launcher to install"
+        required: false
+        type: string
+
+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-test:
+    needs: [check_pr_status, formatter]
+    if: needs.check_pr_status.outputs.branch-pr == ''
+    uses: ./.github/workflows/pytest.yml
+    with:
+      BEC_LAUNCHER_BRANCH: ${{ inputs.BEC_LAUNCHER_BRANCH || 'main' }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  unit-test-matrix:
+    needs: [check_pr_status, formatter]
+    if: needs.check_pr_status.outputs.branch-pr == ''
+    uses: ./.github/workflows/pytest-matrix.yml
+    with:
+      BEC_LAUNCHER_BRANCH: ${{ inputs.BEC_LAUNCHER_BRANCH || 'main' }}

bec_launcher-0.1.0/.github/workflows/formatter.yml

@@ -0,0 +1,61 @@
+name: Formatter and Pylint jobs
+on: [workflow_call]
+jobs:
+
+  Formatter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13' 
+
+      - name: Run black and isort
+        run: |
+          pip install black isort
+          pip install -e .[dev]
+          black --check --diff --color .
+          isort --check --diff ./
+  Pylint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pylint pylint-exit anybadge
+
+      - name: Run Pylint
+        run: |
+          mkdir -p ./pylint
+          set +e
+          pylint ./${{ github.event.repository.name }} --output-format=text > ./pylint/pylint.log
+          pylint-exit $?
+          set -e
+
+      - name: Extract Pylint Score
+        id: score
+        run: |
+          SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log)
+          echo "score=$SCORE" >> $GITHUB_OUTPUT
+
+      - name: Create Badge
+        run: |
+          anybadge --label=Pylint --file=./pylint/pylint.svg --value="${{ steps.score.outputs.score }}" 2=red 4=orange 8=yellow 10=green
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: pylint-artifacts
+          path: |
+            # ./pylint/pylint.log # not sure why this isn't working
+            ./pylint/pylint.svg

bec_launcher-0.1.0/.github/workflows/pytest-matrix.yml

@@ -0,0 +1,35 @@
+name: Run Pytest with different Python versions
+on:
+  workflow_call:
+    inputs:
+      BEC_LAUNCHER_BRANCH:
+        description: "Branch of BEC Launcher to install"
+        required: false
+        default: "main"
+        type: string
+
+jobs:
+  pytest-matrix:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout BEC Launcher
+        uses: actions/checkout@v4
+        with:
+          repository: bec-project/bec_launcher
+          ref: ${{ inputs.BEC_LAUNCHER_BRANCH }}
+
+      - name: Install BEC Launcher and dependencies
+        uses: ./.github/actions/bec_launcher_install
+        with:
+          BEC_LAUNCHER_BRANCH: ${{ inputs.BEC_LAUNCHER_BRANCH }}
+          PYTHON_VERSION: ${{ matrix.python-version }}
+
+      - name: Run Pytest
+        run: |
+          cd ./bec_launcher
+          pip install pytest pytest-random-order
+          pytest -v --maxfail=2 --junitxml=report.xml --random-order ./tests

bec_launcher-0.1.0/.github/workflows/pytest.yml

@@ -0,0 +1,46 @@
+name: Run Pytest with Coverage
+on:
+  workflow_call:
+    inputs:
+      BEC_LAUNCHER_BRANCH:
+        description: "Branch of BEC Launcher to install"
+        required: false
+        default: "main"
+        type: string
+    secrets:
+      CODECOV_TOKEN:
+        required: true
+
+permissions:
+  pull-requests: write
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout BEC Launcher
+        uses: actions/checkout@v4
+        with:
+          repository: bec-project/bec_launcher
+          ref: ${{ inputs.BEC_LAUNCHER_BRANCH }}
+
+      - name: Install BEC Launcher and dependencies
+        uses: ./.github/actions/bec_launcher_install
+        with:
+          BEC_LAUNCHER_BRANCH: ${{ inputs.BEC_LAUNCHER_BRANCH }}
+          PYTHON_VERSION: 3.11
+
+      - name: Run Pytest with Coverage
+        id: coverage
+        run: |
+          cd ./bec_launcher
+          coverage run --source=./bec_launcher --omit=*/bec_launcher/tests/* -m pytest -v --junitxml=report.xml --random-order --full-trace ./tests
+          coverage report
+          coverage xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: bec-project/bec_launcher

bec_launcher-0.1.0/.github/workflows/semantic_release.yml

@@ -0,0 +1,95 @@
+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@v4
+        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@v5
+        with:
+          python-version: '3.11'
+
+      - 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.
+        #
+        # You may consider moving this to a repo script and call it from this step instead
+        # of writing it in-line.
+        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 }}
+        run: |
+          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 upload dist/* -u __token__ -p ${{ secrets.CI_PYPI_TOKEN }} --skip-existing
+          semantic-release publish

bec_launcher-0.1.0/.github/workflows/sync-issues-pr.yml

@@ -0,0 +1,35 @@
+name: Sync PR to Project
+
+on:
+  pull_request:
+    types:
+      [
+        opened,
+        assigned,
+        unassigned,
+        edited,
+        ready_for_review,
+        converted_to_draft,
+        reopened,
+        synchronize,
+        closed,
+      ]
+
+jobs:
+  sync-project:
+    runs-on: ubuntu-latest
+
+    permissions:
+      issues: write
+      pull-requests: read
+      contents: read
+
+    steps:
+      - name: Sync PR to Project
+        uses: bec-project/action-issue-sync-pr@v1
+        with:
+          token: ${{ secrets.ADD_ISSUE_TO_PROJECT }}
+          org: ${{ github.repository_owner }}
+          repo: ${{ github.repository }}
+          project-number: 3
+          pr-number: ${{ github.event.pull_request.number }}

bec_launcher-0.1.0/.gitignore

@@ -0,0 +1,180 @@
+**/*_venv
+**/.idea
+*.log
+**/__pycache__
+**/.DS_Store
+**/out
+**/.vscode
+**/.pytest_cache
+**/*.egg*
+
+# file writer data
+**.h5
+
+# ignore recover_config files
+recovery_config*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+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/
+docs/**/autodoc/
+docs/**/_autosummary/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+**.prof
+
+# 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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/

bec_launcher-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+
+## v0.1.0 (2026-01-09)
+
+### Features
+
+- Simple launch file to demonstrate usage
+  ([`4ee8761`](https://github.com/bec-project/bec_launcher/commit/4ee87619a2dad87a8cd6bd2a28bc3f8b7b05af14))
+
+### Refactoring
+
+- Enhance type safety by introducing DeploymentDict for deployment names
+  ([`47e47da`](https://github.com/bec-project/bec_launcher/commit/47e47dac3cf3aaab5084bc4e32fbd194bf55f54d))

bec_launcher-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Paul Scherrer Institut
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

bec_launcher-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: bec_launcher
+Version: 0.1.0
+Summary: BEC Launcher: A launcher application for BEC clients and tools.
+Project-URL: Bug Tracker, https://github.com/bec-project/bec_launcher/issues
+Project-URL: Homepage, https://github.com/bec-project/bec_launcher
+Project-URL: documentation, https://bec.readthedocs.org
+Project-URL: changelog, https://github.com/bec-project/bec_launcher/blob/main/CHANGELOG.md
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: black~=25.0; extra == 'dev'
+Requires-Dist: coverage~=7.0; extra == 'dev'
+Requires-Dist: isort>=5.13.2,~=5.13; extra == 'dev'
+Requires-Dist: pylint~=3.0; extra == 'dev'
+Requires-Dist: pytest-random-order~=1.1; extra == 'dev'
+Requires-Dist: pytest~=8.0; extra == 'dev'

bec_launcher-0.1.0/README.md

@@ -0,0 +1,15 @@
+# BEC Launcher
+
+A launcher application for BEC clients and tools.
+
+## Installation
+
+```bash
+pip install bec_launcher
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"
+```

bec_launcher-0.1.0/bec_launcher/deployments.py

@@ -0,0 +1,47 @@
+"""
+Simple helpers for fetching available deployments.
+"""
+
+from __future__ import annotations
+
+import os
+from typing import TypedDict
+
+
+class DeploymentDict(TypedDict):
+    """
+    Dictionary structure for deployment names.
+    """
+
+    production: list[str]
+    test: list[str]
+
+
+def get_available_deployments(base_path: str) -> DeploymentDict:
+    """
+    Get a list of available deployments by listing directories in the given base path.
+
+    Returns:
+        DeploymentDict: A dictionary with 'production' and 'test' keys containing lists of deployment names.
+    """
+    out: DeploymentDict = {"production": [], "test": []}
+
+    if not os.path.exists(base_path):
+        return out
+
+    for item in os.listdir(base_path):
+        # Skip if not a directory
+        if not os.path.isdir(os.path.join(base_path, item)):
+            continue
+
+        # Skip if ends with "deployments" or starts with "old"
+        if item.endswith("deployments") or item.startswith("old"):
+            continue
+
+        # If the item starts with "test_", add to test deployments
+        if item.startswith("test"):
+            out["test"].append(item)
+        else:
+            out["production"].append(item)
+
+    return out

bec_launcher-0.1.0/bec_launcher/main.py

@@ -0,0 +1,22 @@
+from bec_launcher.deployments import get_available_deployments
+
+
+def launch(base_path: str) -> None:
+    deployments = get_available_deployments(base_path)
+    print("Launching BEC Launcher...")
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser(description="BEC Launcher")
+    parser.add_argument(
+        "--base-path",
+        type=str,
+        help="Base path for deployments, typically /sls/<beamline>/config/bec",
+        required=True,
+    )
+
+    args = parser.parse_args()
+    base_path = args.base_path
+    launch(base_path)

bec_launcher-0.1.0/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bec_launcher"
+version = "0.1.0"
+description = "BEC Launcher: A launcher application for BEC clients and tools."
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "black~=25.0",
+    "isort~=5.13, >=5.13.2",
+    "coverage~=7.0",
+    "pylint~=3.0",
+    "pytest-random-order~=1.1",
+    "pytest ~= 8.0",
+]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/bec-project/bec_launcher/issues"
+Homepage = "https://github.com/bec-project/bec_launcher"
+documentation = "https://bec.readthedocs.org"
+changelog = "https://github.com/bec-project/bec_launcher/blob/main/CHANGELOG.md"
+
+[tool.hatch.build.targets.wheel]
+include = ["*"]
+
+[tool.isort]
+profile = "black"
+line_length = 100
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.black]
+line-length = 100
+skip-magic-trailing-comma = true
+
+[tool.pylint.basic]
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+good-names-rgxs = [
+    ".*scanID.*",
+    ".*RID.*",
+    ".*pointID.*",
+    ".*ID.*",
+    ".*_2D.*",
+    ".*_1D.*",
+]
+
+[tool.semantic_release]
+build_command = "python -m build"
+version_toml = ["pyproject.toml:project.version"]
+
+[tool.semantic_release.commit_author]
+env = "GIT_COMMIT_AUTHOR"
+default = "semantic-release <semantic-release>"
+
+[tool.semantic_release.commit_parser_options]
+allowed_tags = [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "style",
+    "refactor",
+    "test",
+]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]
+default_bump_level = 0
+
+[tool.semantic_release.remote]
+name = "origin"
+type = "github"
+ignore_token_for_push = true
+
+[tool.semantic_release.remote.token]
+env = "GH_TOKEN"
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+
+[tool.coverage.report]
+skip_empty = true # exclude empty *files*, e.g. __init__.py, from the report
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "return NotImplemented",
+    "raise NotImplementedError",
+    "\\.\\.\\.",
+    'if __name__ == "__main__":',
+]

bec_launcher-0.1.0/tests/test_deployments.py

@@ -0,0 +1,161 @@
+"""
+Tests for deployments module.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+
+from bec_launcher.deployments import get_available_deployments
+
+
+@pytest.fixture
+def temp_deployment_dir(tmpdir):
+    """Create a temporary directory structure for testing."""
+    base_path = Path(tmpdir)
+
+    # Create various directories
+    (base_path / "production").mkdir()
+    (base_path / "test").mkdir()
+    (base_path / "old_production_deployments").mkdir()
+    (base_path / "old_test_deployments").mkdir()
+    (base_path / "production_deployments").mkdir()
+    (base_path / "test_deployments").mkdir()
+
+    # Create a file (should be ignored)
+    (base_path / "readme.txt").touch()
+
+    return str(base_path)
+
+
+def test_get_available_deployments_filters_correctly(temp_deployment_dir):
+    """Test that only valid deployment names are returned."""
+    result = get_available_deployments(temp_deployment_dir)
+
+    assert "production" in result["production"]
+    assert "test" in result["test"]
+    assert len(result["production"]) == 1
+    assert len(result["test"]) == 1
+
+
+def test_get_available_deployments_excludes_old_directories(temp_deployment_dir):
+    """Test that directories starting with 'old' are excluded."""
+    result = get_available_deployments(temp_deployment_dir)
+
+    all_deployments = result["production"] + result["test"]
+    assert not any(d.startswith("old") for d in all_deployments)
+
+
+def test_get_available_deployments_excludes_deployment_suffixed_directories(temp_deployment_dir):
+    """Test that directories ending with 'deployments' are excluded."""
+    result = get_available_deployments(temp_deployment_dir)
+
+    all_deployments = result["production"] + result["test"]
+    assert not any(d.endswith("deployments") for d in all_deployments)
+
+
+def test_get_available_deployments_excludes_files(temp_deployment_dir):
+    """Test that files are not included in the results."""
+    result = get_available_deployments(temp_deployment_dir)
+
+    all_deployments = result["production"] + result["test"]
+    assert "readme.txt" not in all_deployments
+
+
+def test_get_available_deployments_nonexistent_path():
+    """Test behavior when the base path doesn't exist."""
+    result = get_available_deployments("/nonexistent/path")
+
+    assert result == {"production": [], "test": []}
+
+
+def test_get_available_deployments_empty_directory(tmpdir):
+    """Test behavior with an empty directory."""
+    result = get_available_deployments(str(tmpdir))
+
+    assert result == {"production": [], "test": []}
+
+
+def test_get_available_deployments_separates_test_and_production(tmpdir):
+    """Test that test deployments are correctly separated from production."""
+    base_path = Path(tmpdir)
+
+    # Create test deployments
+    (base_path / "test").mkdir()
+    (base_path / "test_env1").mkdir()
+    (base_path / "test_env2").mkdir()
+
+    # Create production deployments
+    (base_path / "production").mkdir()
+    (base_path / "staging").mkdir()
+    (base_path / "dev").mkdir()
+
+    result = get_available_deployments(str(base_path))
+
+    assert "test" in result["test"]
+    assert "test_env1" in result["test"]
+    assert "test_env2" in result["test"]
+    assert len(result["test"]) == 3
+
+    assert "production" in result["production"]
+    assert "staging" in result["production"]
+    assert "dev" in result["production"]
+
+
+def test_get_available_deployments_complex_scenario(tmpdir):
+    """Test with a complex directory structure."""
+    base_path = Path(tmpdir)
+
+    # Valid deployments
+    (base_path / "production").mkdir()
+    (base_path / "test").mkdir()
+    (base_path / "staging").mkdir()
+    (base_path / "test_feature").mkdir()
+
+    # Should be excluded
+    (base_path / "old_production").mkdir()
+    (base_path / "old_test").mkdir()
+    (base_path / "production_deployments").mkdir()
+    (base_path / "test_deployments").mkdir()
+    (base_path / "old_deployments").mkdir()
+
+    # Files (should be ignored)
+    (base_path / "config.yaml").touch()
+
+    result = get_available_deployments(str(base_path))
+
+    # Check production deployments
+    assert "production" in result["production"]
+    assert "staging" in result["production"]
+    assert len(result["production"]) == 2
+
+    # Check test deployments
+    assert "test" in result["test"]
+    assert "test_feature" in result["test"]
+    assert len(result["test"]) == 2
+
+    # Ensure excluded items are not present
+    all_deployments = result["production"] + result["test"]
+    assert "old_production" not in all_deployments
+    assert "old_test" not in all_deployments
+    assert "production_deployments" not in all_deployments
+    assert "test_deployments" not in all_deployments
+    assert "old_deployments" not in all_deployments
+
+
+def test_get_available_deployments_custom_names(tmpdir):
+    """Test with custom deployment names."""
+    base_path = Path(tmpdir)
+
+    # Create custom named deployments
+    (base_path / "saxs").mkdir()
+    (base_path / "test_saxs").mkdir()
+
+    result = get_available_deployments(str(base_path))
+
+    assert "saxs" in result["production"]
+    assert len(result["production"]) == 1
+    assert "test_saxs" in result["test"]
+    assert len(result["test"]) == 1