iperf3-lib 0.2.0__tar.gz → 0.3.0__tar.gz

{iperf3_lib-0.2.0 → iperf3_lib-0.3.0}/.dockerignore

@@ -14,4 +14,6 @@ build
 coverage.xml
 dist
 htmlcov
+site
+.cache
 iperf-3.*

iperf3_lib-0.3.0/.gitattributes

@@ -0,0 +1 @@
+*.sh text eol=lf

iperf3_lib-0.3.0/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,30 @@
+name: Bug report
+description: Report incorrect behavior with a reproducible example.
+labels: [bug]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Expected and observed behavior
+      description: Explain the difference and its impact.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Reproduction
+      description: Include minimal Python code and sanitized native JSON or error output where relevant.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Package version or commit, Python, libiperf version, operating system, protocol, and direction.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance
+    attributes:
+      label: Suggested acceptance checks
+      description: What would demonstrate that this is fixed?

iperf3_lib-0.3.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Security reporting
+    url: https://github.com/dariuszpanas/iperf3-lib/security/policy
+    about: Follow the security policy to report vulnerabilities privately.
+  - name: Documentation
+    url: https://dariuszpanas.github.io/iperf3-lib/
+    about: Check installation, API behavior, and current limitations.

iperf3_lib-0.3.0/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,30 @@
+name: Feature or design proposal
+description: Describe a use case and a bounded proposal.
+labels: [enhancement, planning]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem and use case
+      description: Describe the workflow this would improve and the current workaround.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed behavior and boundaries
+      description: Include API ideas, alternatives, and what is outside the proposed scope.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance
+    attributes:
+      label: Acceptance criteria and evidence
+      description: Include native verification or Prometheus/Grafana checks when relevant.
+    validations:
+      required: true
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: Related issues and compatibility
+      description: Link dependencies and describe migration or platform considerations.

iperf3_lib-0.3.0/.github/ISSUE_TEMPLATE/task.yml

@@ -0,0 +1,21 @@
+name: Maintenance or documentation task
+description: Track a concrete improvement to tooling, docs, or release preparation.
+body:
+  - type: textarea
+    id: outcome
+    attributes:
+      label: Intended outcome
+      description: Explain what needs to change and why.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance
+    attributes:
+      label: Completion checklist
+      description: List concrete, verifiable steps and any follow-up that remains separate.
+    validations:
+      required: true
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: Related issues or pull requests

{iperf3_lib-0.2.0 → iperf3_lib-0.3.0}/.github/dependabot.yml

@@ -1,6 +1,16 @@
 version: 2
 
 updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+      timezone: "America/Los_Angeles"
+    commit-message:
+      prefix: "chore(docker)"
+
   - package-ecosystem: "uv"
     directory: "/"
     schedule:
@@ -45,22 +55,3 @@ updates:
         applies-to: "security-updates"
         patterns:
           - "*"
-
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "09:30"
-      timezone: "America/Los_Angeles"
-    commit-message:
-      prefix: "chore(docker)"
-    groups:
-      docker-images:
-        applies-to: "version-updates"
-        patterns:
-          - "*"
-      docker-security:
-        applies-to: "security-updates"
-        patterns:
-          - "*"

{iperf3_lib-0.2.0 → iperf3_lib-0.3.0}/.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
     branches: [main]
   pull_request:
     branches: [main]
+    types: [opened, synchronize, reopened, edited, ready_for_review]
   schedule:
     # Run the full compatibility matrix monthly as a maintenance reminder.
     - cron: "17 9 1 * *"
@@ -26,11 +27,15 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          fetch-depth: 0
+          persist-credentials: false
 
       - name: Install uv and Python
-        uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+        id: setup-uv
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
         with:
-          version: "0.11.31"
           python-version: "3.12"
           enable-cache: true
           cache-dependency-glob: uv.lock
@@ -41,6 +46,35 @@ jobs:
       - name: Run non-mutating checks
         run: make check
 
+      - name: Run unit tests
+        run: make test
+
+      - name: Lint GitHub workflows with YAGA
+        run: make workflow-lint
+
+      - name: Check source and test changes
+        if: github.event_name == 'pull_request'
+        env:
+          YAGA_RANGE: ${{ format('{0}...{1}', github.event.pull_request.base.sha, github.event.pull_request.head.sha) }}
+        run: >-
+          uv run --frozen yaga change check
+          --policy .yaga/change-policy.toml --range "$YAGA_RANGE" --format github
+
+  commit-policy:
+    name: YAGA commit policy
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Check out pull request history
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Check pull request title and commits
+        uses: dariuszpanas/yaga/actions/commit-check@f61bbfa878447157239bb92ff67977bd64400afd # v0.2.0
+
   docker-matrix-tests:
     name: docker (${{ matrix.python }}, iperf ${{ matrix.iperf }})
     runs-on: ubuntu-latest
@@ -54,12 +88,14 @@ jobs:
     steps:
       - name: Check out repository
         uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0
+        uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
 
       - name: Build compatibility image
-        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
+        uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
         with:
           context: .
           load: true
@@ -76,41 +112,10 @@ jobs:
             "iperf3-lib-test:py${{ matrix.python }}-iperf${{ matrix.iperf }}" \
             bash -c "python --version && iperf3 --version && pytest -vv --cov=iperf3_lib --cov-report=term-missing"
 
-  python-preview:
-    name: python 3.15 preview (allowed failure)
-    runs-on: ubuntu-latest
-    needs: lint-and-types
-    continue-on-error: true
-    timeout-minutes: 30
-    steps:
-      - name: Check out repository
-        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0
-
-      - name: Build preview image
-        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
-        with:
-          context: .
-          load: true
-          tags: iperf3-lib-test:py315-preview-iperf321
-          build-args: |
-            PYTHON_BASE=python:3.15-rc-slim
-            IPERF3_VERSION=3.21
-          cache-from: type=gha,scope=py315-preview-iperf321
-          cache-to: type=gha,mode=max,scope=py315-preview-iperf321
-
-      - name: Run preview suite
-        run: |
-          docker run --rm -v "${{ github.workspace }}:/app" \
-            iperf3-lib-test:py315-preview-iperf321 \
-            bash -c "python --version && iperf3 --version && pytest -vv --cov=iperf3_lib --cov-report=term-missing"
-
   ci:
     name: ci
     runs-on: ubuntu-latest
-    needs: [lint-and-types, docker-matrix-tests]
+    needs: [lint-and-types, commit-policy, docker-matrix-tests]
     if: ${{ always() }}
     timeout-minutes: 5
     steps:
@@ -118,6 +123,11 @@ jobs:
         env:
           LINT_RESULT: ${{ needs.lint-and-types.result }}
           TEST_RESULT: ${{ needs.docker-matrix-tests.result }}
+          COMMIT_RESULT: ${{ needs.commit-policy.result }}
+          EVENT_NAME: ${{ github.event_name }}
         run: |
           test "$LINT_RESULT" = "success"
           test "$TEST_RESULT" = "success"
+          if [ "$EVENT_NAME" = "pull_request" ]; then
+            test "$COMMIT_RESULT" = "success"
+          fi

iperf3_lib-0.3.0/.github/workflows/docs.yml

@@ -0,0 +1,57 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build documentation
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - name: Install uv and Python
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          python-version: "3.12"
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+      - name: Synchronize frozen dependencies
+        run: uv sync --frozen --dev
+      - name: Build and check documentation
+        run: make docs
+      - name: Upload documentation
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
+        with:
+          path: site
+
+  deploy:
+    name: Deploy documentation
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5