xrdclient 0.1.0__tar.gz

xrdclient-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,125 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e ".[dev]"
+      - name: ruff
+        run: ruff check src tests benchmarks tools examples
+      - name: mypy --strict
+        run: mypy
+      - name: maintainability burn-down (must reach zero)
+        run: python tools/maintainability.py check
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        include:
+          - os: macos-latest
+            python-version: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # The point of the library is that it needs nothing compiled; installing
+      # the fsspec extra as well keeps that adapter's tests from silently
+      # skipping on every run.
+      - run: pip install -e ".[dev]"
+      # pytest-cov rather than `coverage run`, because the workers xdist
+      # spawns are separate processes and only pytest-cov collects them all.
+      # `fail_under = 100` on proto/, crypto/ and client/ comes from
+      # pyproject.toml, so the gate lives with the configuration.
+      - name: pytest
+        run: >-
+          pytest -q -p no:cacheprovider -n auto
+          -m "not interop and not parity"
+          --cov=xrdclient --cov-report=term-missing
+
+  interop:
+    # A real daemon, because a fake written from the same reading of the
+    # specification as the client would agree with a misreading.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: "3.12"
+          channels: conda-forge
+          auto-activate-base: false
+          activate-environment: interop
+      - name: install xrootd and the official bindings
+        shell: bash -el {0}
+        run: conda install -y xrootd
+      - name: install
+        shell: bash -el {0}
+        run: pip install -e ".[dev]"
+      - name: interop and parity
+        shell: bash -el {0}
+        run: |
+          xrootd -v
+          pytest -q -p no:cacheprovider -m "interop or parity"
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e ".[docs]"
+      # --strict turns a broken link or a page missing from the nav into a
+      # failure, which is the only way documentation stays true.
+      - run: mkdocs build --strict
+
+  performance:
+    # A gate, not a report: every case in benchmarks/compare.py must be won
+    # against the official XRootD bindings on the same runner, by both the
+    # native API and xrdclient.compat. Rounds are paired and interleaved and
+    # a win must pass a one-sided sign test, so a noisy runner cannot turn a
+    # loss into a pass by luck - only into a failure, which is re-runnable.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: "3.12"
+          channels: conda-forge
+          activate-environment: bench
+      - shell: bash -el {0}
+        run: conda install -y xrootd
+      - shell: bash -el {0}
+        run: pip install -e .
+      - name: loopback
+        shell: bash -el {0}
+        run: python benchmarks/compare.py --gate --size 64 --rounds 15 --json loopback.json
+      - name: 2 ms round trip
+        shell: bash -el {0}
+        run: python benchmarks/compare.py --gate --size 64 --rounds 15 --rtt 2 --json rtt2.json
+      - if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: performance
+          path: "*.json"

xrdclient-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+# Builds the sdist and wheel on a version tag and uploads them to PyPI through
+# trusted publishing (no API token: PyPI trusts this workflow's OIDC identity,
+# registered under the project's "Publishing" settings).
+name: Publish
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

xrdclient-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+__pycache__/
+*.py[cod]
+
+# Build artefacts
+build/
+dist/
+*.egg-info/
+site/
+
+# Tooling caches and coverage data
+.coverage
+.coverage.*
+htmlcov/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.tox/
+.venv/
+venv/
+
+# Generated datasets
+/datasets/