katcp-codec 0.1.0__tar.gz

katcp_codec-0.1.0/.ci/before_all_linux.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e -u
+
+# Install Rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --default-toolchain=${RUST_VERSION:-stable} --profile=minimal -y

katcp_codec-0.1.0/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

katcp_codec-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,193 @@
+name: Unit tests
+on: [push, pull_request]
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+env:
+  RUST_VERSION: '1.76.0'
+  MIN_PYTHON_VERSION: '3.8'
+  MAX_PYTHON_VERSION: '3.12'
+jobs:
+  pre-commit:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MIN_PYTHON_VERSION }}
+          cache: 'pip'
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+          components: rustfmt, clippy
+      - uses: Swatinem/rust-cache@v2
+      - name: Install pre-commit
+        run: pip install -c requirements.txt pre-commit
+      - name: Run pre-commit checks
+        run: pre-commit run --all-files
+
+  docs:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MIN_PYTHON_VERSION }}
+          cache: 'pip'
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@v2
+      - name: Build Rust docs
+        # Document private items to validate their doc formatting.
+        run: RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --document-private-items --locked
+      - name: Install Python doc dependencies
+        run: pip install -r doc-requirements.txt
+      - name: Install Python package
+        run: pip install .
+      - name: Build Python docs
+        run: SPHINX_OPTS="-W --keep-going" make -C doc html
+
+  rust-tests:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version:  ${{ env.MAX_PYTHON_VERSION }}
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@v2
+      - name: Run Rust tests
+        run: RUSTFLAGS="-D warnings" cargo test --locked
+      - name: Run Rust benchmarks
+        run: cargo bench --locked
+
+  python-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.8', '3.9', '3.10', '3.11', '3.12']
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: 'pip'
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@v2
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Install package
+        run: pip install .
+      - name: Run Python tests
+        run: pytest -v -ra
+
+  linux-wheels:
+    needs: [pre-commit, python-tests, rust-tests]
+    strategy:
+      fail-fast: false
+      matrix:
+        arch: [x86_64, aarch64]
+        python: [cp38]  # Using limited ABI, so newer versions are not required
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: docker/setup-qemu-action@v3
+        with:
+          platforms: arm64
+        if: matrix.arch != 'x86_64'
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@v2
+      - uses: pypa/cibuildwheel@v2.17.0
+        env:
+          CIBW_ARCHS: ${{ matrix.arch }}
+          CIBW_BUILD: ${{ matrix.python }}-manylinux*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel_linux-${{ matrix.arch }}-${{ matrix.python }}
+          path: ./wheelhouse/*.whl
+
+  macos-wheels:
+    needs: [pre-commit, python-tests, rust-tests]
+    strategy:
+      fail-fast: false
+      matrix:
+        arch: [x86_64, arm64]
+        python: [cp38]  # Using limited ABI, so newer versions are not required
+    runs-on: macos-14
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: dtolnay/rust-toolchain@v1
+        with:
+          toolchain: ${{ env.RUST_VERSION }}
+      - uses: Swatinem/rust-cache@v2
+      - name: Install x86_64 Rust compiler
+        run: rustup target add x86_64-apple-darwin
+        if: matrix.arch == 'x86_64'
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAX_PYTHON_VERSION }}
+          cache: 'pip'
+      - name: Install pipx
+        run: pip install pipx
+      - uses: pypa/cibuildwheel@v2.17.0
+        env:
+          CIBW_ARCHS: ${{ matrix.arch }}
+          CIBW_BUILD: ${{ matrix.python }}-macos*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel_macos-${{ matrix.arch }}-${{ matrix.python }}
+          path: ./wheelhouse/*.whl
+
+  sdist:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MIN_PYTHON_VERSION }}
+          cache: 'pip'
+      - name: install build tool
+        run: pip install -c requirements.txt build
+      - name: build sdist
+        run: python -m build --sdist .
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: ./dist/*.tar.gz
+
+  combine-wheels:
+    needs: [linux-wheels, macos-wheels, sdist]
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Create paths
+        run: mkdir -p dist wheelhouse
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: wheel_*
+          path: wheelhouse/
+          merge-multiple: true
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist/
+          merge-multiple: true
+      - uses: actions/upload-artifact@v4
+        with:
+          name: release
+          path: |
+            dist/
+            wheelhouse/

katcp_codec-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+/build
+/target
+/dist
+/wheelhouse
+*.egg-info
+_lib.*.so
+_lib.*.dylib

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

@@ -0,0 +1,42 @@
+repos:
+  - repo: https://github.com/doublify/pre-commit-rust
+    rev: v1.0
+    hooks:
+      - id: fmt
+      - id: clippy
+  - repo: https://github.com/psf/black
+    rev: 24.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ["--filter-files"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.3
+    hooks:
+      - id: ruff
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+      - id: mypy
+        # Passing filenames to mypy can do odd things.
+        # pyproject.toml determines the set of files that will actually be checked.
+        pass_filenames: false
+        # The pre-commit hook passes some options, but we set options in pyproject.toml.
+        args: []
+        additional_dependencies:
+          - pytest==8.1.1
+  - repo: https://github.com/jazzband/pip-tools
+    rev: 7.4.1
+    hooks:
+      - id: pip-compile
+        language_version: python3.8
+        args: ["--output-file=requirements.txt", "--extra=dev", "--strip-extras", "pyproject.toml"]
+        files: '^(pyproject\.toml|requirements\.txt)$'
+      - id: pip-compile
+        name: pip-compile doc-requirements
+        language_version: python3.8
+        args: ["--output-file=doc-requirements.txt", "--extra=doc", "--strip-extras", "pyproject.toml"]
+        files: '^(pyproject\.toml|doc-requirements\.txt)$'

katcp_codec-0.1.0/.readthedocs.yml

@@ -0,0 +1,30 @@
+################################################################################
+# Copyright (c) 2024, National Research Foundation (SARAO)
+#
+# Licensed under the BSD 3-Clause License (the "License"); you may not use
+# this file except in compliance with the License. You may obtain a copy
+# of the License at
+#
+#   https://opensource.org/licenses/BSD-3-Clause
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+################################################################################
+
+version: 2
+build:
+  os: ubuntu-22.04
+  apt_packages:
+    - pdf2svg  # For sphinxcontrib-tikz
+  tools:
+    python: "3.12"
+    rust: "1.75"
+
+python:
+  install:
+    - requirements: doc-requirements.txt
+    - method: pip
+      path: .