qcdrivers 0.1.0__tar.gz

qcdrivers-0.1.0/.gitattributes

@@ -0,0 +1,34 @@
+# Line-ending normalisation.
+#
+# Text files are stored LF in the repository and checked out LF everywhere,
+# including Windows. Without this the working tree depends on each clone's
+# core.autocrlf setting, so the same file differs between machines and a
+# formatter that enforces LF fights the checkout on every commit.
+#
+# Applying this renormalises files whose stored form is currently CRLF. Run
+# `git add --renormalize .` once, in its own commit.
+* text=auto eol=lf
+
+# cmd.exe requires CRLF in batch files.
+*.bat text eol=crlf
+*.cmd text eol=crlf
+
+# Shell scripts must stay LF or they fail on Linux and macOS with ^M errors.
+*.sh text eol=lf
+
+# Binary assets: never convert, never diff as text.
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.webp binary
+*.pdf binary
+*.zip binary
+*.woff binary
+*.woff2 binary
+*.ttf binary
+*.otf binary
+
+# Collapse the lockfile in GitLab merge request diffs; it is generated output.
+uv.lock -diff linguist-generated=true gitlab-generated=true

qcdrivers-0.1.0/.gitignore

@@ -0,0 +1,67 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.DS_Store
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.tox/
+.nox/
+.uv-cache/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+report.xml
+*.cover
+*.py,cover
+.pytest_cache/
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+*_env/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.DS_Store

qcdrivers-0.1.0/.gitlab-ci.yml

@@ -0,0 +1,178 @@
+image: "python:3.13"
+
+# Branch model: feature branches -> preview -> main. Everything is linted and
+# tested on every branch, preview additionally proves the package builds, and
+# only main creates a release.
+
+stages:
+  - format
+  - test
+  - release
+
+include:
+  - template: Security/SAST.gitlab-ci.yml
+  - template: Security/Secret-Detection.gitlab-ci.yml
+
+variables:
+  SECRET_DETECTION_ENABLED: "true"
+  UV_CACHE_DIR: "$CI_PROJECT_DIR/.uv-cache"
+
+sast:
+  stage: test
+
+secret_detection:
+  stage: test
+
+lint:
+  stage: format
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+    # Keep this exact version aligned with pyproject.toml and pre-commit.
+    - uv tool install ruff@0.16.6
+  script:
+    - ruff check .
+    - ruff format --check .
+
+pytest:
+  stage: test
+  # Python 3.13 is the supported runtime for this release.
+  parallel:
+    matrix:
+      - PYTHON_VERSION: ["3.13"]
+  image: "python:${PYTHON_VERSION}"
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - uv sync --python "$PYTHON_VERSION" --extra test
+    - uv run --python "$PYTHON_VERSION" pytest --cov --cov-report=term --cov-report=xml --junitxml=report.xml
+  coverage: '/^TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+  cache:
+    key: uv-$CI_JOB_NAME-$PYTHON_VERSION
+    paths:
+      - .uv-cache
+
+# Windows gets a full run because Zarr stores and file locking behave
+# differently there. Coverage is reported by the Linux jobs only.
+pytest-windows:
+  stage: test
+  tags:
+    - windows
+  variables:
+    PYTHON_VERSION: "3.13"
+  before_script:
+    - powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+    - $env:Path = "$env:USERPROFILE\.local\bin;$env:Path"
+  script:
+    - uv sync --python $env:PYTHON_VERSION --extra test
+    - uv run --python $env:PYTHON_VERSION pytest --junitxml=report.xml
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+  cache:
+    key: uv-$CI_JOB_NAME-$PYTHON_VERSION
+    paths:
+      - .uv-cache
+
+semantic_release:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  variables:
+    # semantic-release needs all commits and tags to calculate the next version.
+    GIT_DEPTH: 0
+    GIT_STRATEGY: clone
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+    - git config --global user.name "Janitor"
+    - git config --global user.email "squad@fz-juelich.de"
+    - git remote set-url origin https://squad_janitor:$CI_FORMAT@$CI_SERVER_HOST/$CI_PROJECT_NAMESPACE/$CI_PROJECT_NAME
+    # GitLab checks out a detached HEAD, while semantic-release needs a branch.
+    - git fetch origin $CI_COMMIT_BRANCH
+    - git checkout $CI_COMMIT_BRANCH
+    - git reset --hard origin/$CI_COMMIT_BRANCH
+    - uv tool install python-semantic-release
+  script:
+    - |
+      RELEASE_TAG="$(semantic-release version --print-tag)"
+      LAST_TAG="$(semantic-release version --print-last-released-tag)"
+      if [ "$RELEASE_TAG" = "$LAST_TAG" ]; then
+        echo "No release-worthy commits; no version will be published."
+        echo "RELEASE_CREATED=false" > release.env
+        exit 0
+      fi
+      echo "RELEASE_CREATED=true" > release.env
+      echo "RELEASE_TAG=$RELEASE_TAG" >> release.env
+      semantic-release version --push --changelog --no-vcs-release
+  artifacts:
+    paths:
+      - dist/
+      - CHANGELOG.md
+      - release.env
+    expire_in: never
+    reports:
+      dotenv: release.env
+
+gitlab_release:
+  stage: release
+  image: registry.gitlab.com/gitlab-org/cli:latest
+  needs:
+    - job: semantic_release
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  variables:
+    GLAB_ENABLE_CI_AUTOLOGIN: "true"
+  script:
+    - |
+      if [ "$RELEASE_CREATED" != "true" ]; then
+        echo "semantic-release did not cut a version; no GitLab Release needed."
+        exit 0
+      fi
+      unset GITLAB_TOKEN GITLAB_ACCESS_TOKEN OAUTH_TOKEN
+      glab release create "$RELEASE_TAG" \
+        --name "Release $RELEASE_TAG" \
+        --notes-file CHANGELOG.md \
+        --ref "$RELEASE_TAG"
+
+pypi:
+  stage: release
+  needs:
+    - job: semantic_release
+      artifacts: true
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main" && $PYPI_SPANDAN
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - |
+      if ! ls dist/*.whl >/dev/null 2>&1; then
+        echo "semantic-release produced no distribution -- nothing to publish."
+        exit 0
+      fi
+    - uv publish --token "$PYPI_SPANDAN"
+
+build_package:
+  stage: release
+  rules:
+    - if: $CI_COMMIT_BRANCH == "preview"
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - source $HOME/.local/bin/env
+  script:
+    - uv build
+  artifacts:
+    paths:
+      - dist/*.tar.gz
+      - dist/*.whl

qcdrivers-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+# Run `uv sync --extra dev` then `uv run pre-commit install` once per clone.
+#
+# Rules live in pyproject.toml ([tool.ruff]), so these hooks apply exactly the
+# same configuration as the CI `lint` job.
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Keep this exact version aligned with pyproject.toml and .gitlab-ci.yml.
+    rev: v0.16.6
+    hooks:
+      # NOTE: Import sorting is part of `ruff check` via the "I" rules; the `ruff format`
+      # does not do it.
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+        # A check to ensure large files, e.g., test measurement data, does not end up in the repository.
+        args: [--maxkb=512]
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        # Two trailing spaces are a hard line break in Markdown; stripping them
+        # silently reflows the README and the docs pages.
+        args: [--markdown-linebreak-ext=md]

qcdrivers-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

qcdrivers-0.1.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+## QCDrivers Changelog
+
+<!-- version list -->
+
+## v0.1.0 (2026-09-06)
+
+- Initial Release

qcdrivers-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to QCDrivers
+
+Thank you for contributing to QCDrivers. Contributions may include new drivers,
+improvements to existing drivers, bug fixes, tests, and documentation.
+
+## Before you begin
+
+For a larger change, please open an
+[issue](https://gitlab.com/squad-lab/qcdrivers/-/issues) first so that the
+implementation can be discussed before work begins. Bug reports should include
+the instrument model, relevant firmware version, connection method, and enough
+information to reproduce the problem.
+
+## Development setup
+
+QCDrivers requires Python 3.13. Clone the repository and install the development
+dependencies with `uv`:
+
+```console
+git clone https://gitlab.com/squad-lab/qcdrivers
+cd qcdrivers
+uv sync --extra dev
+uv run pre-commit install
+```
+
+Create a separate branch for each contribution. This keeps changes focused and
+makes them easier to review.
+
+## Adding or updating a driver
+
+Drivers belong in `src/qcdrivers/` and are grouped first by manufacturer and then
+by instrument category. Please use the existing packages as a reference and keep
+instrument-specific implementation details in their own modules.
+
+Every package should expose its public classes from `__init__.py` and list them in
+`__all__`. Users should be able to import a driver from its category package
+without knowing the name of its implementation module. For example:
+
+```python
+from qcdrivers.basel.dacs import BaselDac2
+```
+
+New drivers should follow the QCoDeS conventions, include clear documentation,
+and avoid introducing dependencies that are not required by the driver. Please
+update the README or any relevant driver documentation when public behavior or
+usage changes.
+
+## Tests
+
+Add automated tests under `tests/` whenever the behavior can be tested without
+physical hardware. Hardware communication should be mocked or replaced with a
+small stub where practical.
+
+Interactive hardware bring-up scripts belong in `tests/hardware/`. Their names
+must not match pytest's `test_*.py` or `*_test.py` patterns, because these scripts
+may use hard-coded addresses and must never run in CI.
+
+Run the test suite before submitting a change:
+
+```console
+uv run pytest
+```
+
+## Code quality
+
+Run the same linting and formatting checks used by CI:
+
+```console
+uv run ruff check .
+uv run ruff format --check .
+uv run pre-commit run --all-files
+```
+
+To apply Ruff's automatic fixes and formatting locally, run:
+
+```console
+uv run ruff check --fix .
+uv run ruff format .
+```
+
+## Merge requests
+
+Open a merge request with a clear description of the change, the reason for it,
+and how it was tested. Keep unrelated changes in separate merge requests and
+call out anything that could not be tested without hardware.
+
+Feature branches normally merge into `preview`, where the package is built and
+tested before release. The `main` branch is used for releases. All merge requests
+must pass the lint, test, security, and secret-detection jobs configured in the
+GitLab pipeline.