iperf3-lib 0.1.0__tar.gz

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

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint-and-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+      - name: Install Python via uv
+        run: uv python install 3.12
+      - name: Install deps & run checks
+        run: |
+          uv sync --dev
+          make check
+
+  docker-matrix-tests:
+    runs-on: ubuntu-latest
+    needs: lint-and-types
+    strategy:
+      matrix:
+        python_base: ["python:3.12-slim", "python:3.13-slim", "python:3.14-slim"]
+        iperf_version: ["3.18", "3.19.1", "3.20"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build docker test image
+        run: |
+          PY_BASE="${{ matrix.python_base }}"
+          SANITIZED_PY_BASE="${PY_BASE//:/-}"
+          TAG="py-iperf3-test:${SANITIZED_PY_BASE}-${{ matrix.iperf_version }}"
+          docker build \
+            --build-arg PYTHON_BASE="${PY_BASE}" \
+            --build-arg IPERF3_VERSION=${{ matrix.iperf_version }} \
+            -t "${TAG}" .
+      - name: Run tests in container
+        run: |
+          PY_BASE="${{ matrix.python_base }}"
+          SANITIZED_PY_BASE="${PY_BASE//:/-}"
+          TAG="py-iperf3-test:${SANITIZED_PY_BASE}-${{ matrix.iperf_version }}"
+          docker run --rm -v "${{ github.workspace }}:/app" "${TAG}" \
+            bash -c "pytest -vvv --cov=src --cov-report=term-missing"

iperf3_lib-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,144 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release (e.g., 0.1.0)"
+        required: true
+        type: string
+
+jobs:
+  build:
+    name: Build Package
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y iperf3
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --frozen
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  test:
+    name: Test Built Package
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y iperf3
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create venv and install built package
+        run: |
+          uv venv --python ${{ matrix.python-version }}
+          uv pip install dist/*.whl
+
+      - name: Verify import
+        run: |
+          uv run python -c "import iperf3_lib; print('iperf3-lib imported successfully')"
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-latest
+    needs: [build, test]
+    if: github.event_name == 'workflow_dispatch'
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/iperf3-lib
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [build, test]
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/project/iperf3-lib
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: publish-pypi
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: false
+          prerelease: ${{ contains(github.ref, '-alpha') || contains(github.ref, '-beta') || contains(github.ref, '-rc') }}

iperf3_lib-0.1.0/.gitignore

@@ -0,0 +1,213 @@
+# 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/
+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__/
+
+# iPerf source files
+iperf-3.*
+
+# IntelliJ IDEA
+.idea/

iperf3_lib-0.1.0/Dockerfile

@@ -0,0 +1,64 @@
+ARG PYTHON_BASE=python:3.12-slim
+FROM ${PYTHON_BASE}
+
+# Build-time argument to select which iperf3 release to build
+# Default to 3.20 (use ARG to override if needed)
+ARG IPERF3_VERSION=3.20
+
+# Install system dependencies: build tools, runtime libs, and packages needed to build iperf3
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        build-essential \
+        autoconf \
+        automake \
+        libtool \
+        pkg-config \
+        git \
+        curl \
+        ca-certificates \
+        libssl-dev \
+        zlib1g-dev \
+        libffi-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+ARG IPERF3_ENABLE_MPTCP=0
+# Build and install iperf3 from source so we can select a new enough version
+RUN set -eux; \
+    cd /tmp; \
+    # prefer official es.net downloads which publish tarballs like iperf-3.19.1.tar.gz
+    curl -fsSL -o iperf.tar.gz "https://downloads.es.net/pub/iperf/iperf-${IPERF3_VERSION}.tar.gz"; \
+    tar xzf iperf.tar.gz; \
+    cd iperf-*; \
+    # Some releases include configure, others need bootstrap; try both
+    if [ -x ./bootstrap.sh ]; then ./bootstrap.sh; fi; \
+    if [ -x ./configure ]; then \
+        # Run the package's configure script with a standard prefix. Enabling
+        # MPTCP at build time requires kernel and header support on the host
+        # which may not be present inside the container; do not force it here.
+        ./configure --prefix=/usr/local || true; \
+    fi; \
+    make -j"$(nproc)"; \
+    make install; \
+    ldconfig; \
+    rm -rf /tmp/iperf*;
+
+# Create app directory (code will be mounted here at runtime)
+WORKDIR /app
+
+# Create and activate a virtual environment
+ENV VIRTUAL_ENV=/opt/venv
+RUN python -m venv $VIRTUAL_ENV
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
+# Pre-install common dependencies so they're cached in the image
+# (cffi, pydantic, pytest, pytest-asyncio, ty - the actual project install happens at runtime)
+RUN pip install --no-cache-dir --upgrade pip setuptools wheel && \
+    pip install --no-cache-dir cffi pydantic pytest pytest-asyncio ty
+
+# Entrypoint script: install project in editable mode then run command
+# This allows code changes without rebuilding the image
+COPY docker-entrypoint.sh /usr/local/bin/
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+
+ENTRYPOINT ["docker-entrypoint.sh"]
+CMD ["pytest", "-q"]

iperf3_lib-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dariusz Panas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

iperf3_lib-0.1.0/Makefile

@@ -0,0 +1,67 @@
+.PHONY: help install test test-cov test-integration lint format type-check check clean docker-build docker-test docker-shell all
+
+# Default target
+help:
+	@echo "Available targets:"
+	@echo "  install          - Install project with dev dependencies (using uv)"
+	@echo "  all              - Format, type-check, and run the full test suite (including integration)"
+	@echo "  test             - Run tests (excluding integration)"
+	@echo "  test-cov         - Run tests with coverage report"
+	@echo "  test-integration - Run integration tests (requires iperf3 server)"
+	@echo "  lint             - Run ruff linter (via uv)"
+	@echo "  format           - Format code with ruff (via uv)"
+	@echo "  type-check       - Run ty type checker (via uv)"
+	@echo "  check            - Run all checks (lint, format check, type-check)"
+	@echo "  clean            - Remove build artifacts and caches"
+	@echo "  docker-build     - Build Docker test image"
+	@echo "  docker-test      - Run tests in Docker container"
+	@echo "  docker-shell     - Open shell in Docker container"
+
+# Installation
+install:
+	# Sync project virtualenv and install dev dependencies via uv
+	uv sync --dev
+
+# Testing
+test:
+	uv run pytest -v -m "not integration"
+
+test-cov:
+	uv run pytest -v -m "not integration" --cov=src --cov-report=term-missing --cov-report=html
+
+test-integration:
+	uv run pytest -v -m integration
+
+# Code quality
+lint:
+	uv run ruff check src tests
+
+format:
+	uv run ruff format src tests
+	uv run ruff check --fix src tests
+
+type-check:
+	uv run ty check src
+
+check: lint type-check
+	uv run ruff format --check src tests
+
+# Cleanup
+clean:
+	rm -rf build dist *.egg-info .pytest_cache .coverage htmlcov .ruff_cache
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete 2>/dev/null || true
+
+# Docker targets
+docker-build:
+	docker build -t py-iperf3-test .
+
+docker-test: docker-build
+	docker run --rm -v "$(CURDIR):/app" py-iperf3-test bash -c "pytest -vvv --cov=src --cov-report=term-missing --cov-report=xml"
+
+# Aggregate target: format, type-check, and docker-test (full run)
+all: format type-check docker-test
+
+
+docker-shell: docker-build
+	docker run --rm -it -v "$(CURDIR):/app" py-iperf3-test bash

iperf3_lib-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: iperf3-lib
+Version: 0.1.0
+Summary: Modern Python wrapper for iperf3 using cffi (libiperf), with async support.
+Project-URL: Homepage, https://github.com/dariuszpanas/iperf3-lib
+Project-URL: Documentation, https://github.com/dariuszpanas/iperf3-lib/tree/main/docs
+Project-URL: Repository, https://github.com/dariuszpanas/iperf3-lib
+Project-URL: Issues, https://github.com/dariuszpanas/iperf3-lib/issues
+Author: Dariusz Panas
+License-Expression: MIT
+License-File: LICENSE
+Keywords: MPTCP,SCTP,async,benchmark,cffi,iperf3,network,throughput
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Benchmark
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.12
+Requires-Dist: cffi>=1.16
+Requires-Dist: pydantic>=2.8
+Description-Content-Type: text/markdown
+
+# iperf3-lib
+
+Modern Python wrapper for **iperf3** using **cffi** against **libiperf**.  
+- Typed configs/results (Pydantic)
+- Sync + Async APIs
+- Feature detection for SCTP / bidirectional / MPTCP (when lib supports it)
+- Ready for `uv` workflows, ruff/ty/pytest
+
+## Quickstart
+
+```bash
+# create env & install
+uv venv
+source .venv/bin/activate
+uv pip install -e ".[dev]"
+```
+
+You need a system libiperf (install iperf3 via your package manager).
+To point to a non-standard library path:
+
+```bash
+export IPERF3_LIB=/usr/local/lib/libiperf.so
+```
+
+```python
+from iperf3_lib.config import ClientConfig, Protocol
+from iperf3_lib.iperf_client import Client
+
+cfg = ClientConfig(server="127.0.0.1", duration=2, protocol=Protocol.TCP, parallel=2)
+res = Client(cfg).run()
+print("OK:", res.ok, "Mbps:", f"{res.summary_mbps:.2f}", "err:", res.error)
+```
+Notes
+* Full features require a recent libiperf (iperf3 ≥ 3.19.x recommended).
+* Some symbols may not exist on older builds; we detect and degrade gracefully.
+* Integration tests are marked with @pytest.mark.integration.
+
+---
+
+## Running tests
+
+- Run tests locally with Docker (recommended for Windows):
+
+```bash
+# build the test image (pick python base and iperf version if needed)
+docker build --build-arg PYTHON_BASE=python:3.12-slim --build-arg IPERF3_VERSION=3.20 -t py-iperf3-test .
+
+# run the full test suite inside the container (mounted volume allows editing without rebuilding)
+docker run --rm -v "$(pwd):/app" py-iperf3-test bash -c "pytest -vv --cov=src --cov-report=term-missing"
+```
+
+- Quick single-test run (example):
+
+```bash
+docker run --rm -v "$(pwd):/app" py-iperf3-test bash -c "pytest -q tests/test_client_integration_configs.py::test_client_various_configs\[udp_rate\] -vv"
+```
+
+Notes about optional features
+- MPTCP and some other features are optional and require the libiperf to be built with kernel/header support. Tests that exercise optional features will be skipped or xfailed depending on whether the built shared object exports the required symbol.
+
+CI
+- This repository includes a GitHub Actions workflow that builds and runs the tests inside the Docker image for a matrix of Python base images and iperf versions (see `.github/workflows/ci.yml`).
+
+---
+
+```markdown
+# Changelog
+
+## 0.1.0
+- Initial release: cffi (ABI) wrapper of libiperf (client & server),
+  Pydantic models, async support, ruff/ty/pytest, CI with uv.
+
+```