lkh-rs 0.1.0__tar.gz

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

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+permissions:
+  contents: read
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rust:
+    name: Rust (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Install bindgen dependencies (Ubuntu)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
+
+      - name: Install bindgen dependencies (Windows)
+        if: runner.os == 'Windows'
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          version: "18"
+
+      - name: Format
+        run: cargo fmt --check
+
+      - name: Check
+        run: cargo check --all-targets
+
+      - name: Check raw FFI feature
+        run: cargo check --all-targets --features unsafe-ffi
+
+      - name: Test
+        run: cargo test --features unsafe-ffi
+
+      - name: Package verification
+        run: cargo package

lkh_rs-0.1.0/.github/workflows/python.yml

@@ -0,0 +1,55 @@
+name: Python wheels
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  wheels:
+    name: Wheels (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - name: Install bindgen dependencies (Ubuntu)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
+
+      - name: Install bindgen dependencies (Windows)
+        if: runner.os == 'Windows'
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          version: "18"
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: --release --features python-extension-module --compatibility pypi --out dist
+          manylinux: "2014"
+
+      - name: Smoke test wheel
+        shell: bash
+        run: |
+          python -m pip install dist/*.whl
+          python -c "import lkh_rs; print(lkh_rs.solve_parameter_file('tests/fixtures/tiny.par'))"

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

@@ -0,0 +1,194 @@
+name: Release
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  release-plan:
+    name: Release plan
+    runs-on: ubuntu-latest
+    outputs:
+      publish: ${{ steps.plan.outputs.publish }}
+      version: ${{ steps.plan.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - name: Check package version and registry state
+        id: plan
+        shell: bash
+        run: |
+          set -euo pipefail
+          version="$(cargo metadata --no-deps --format-version 1 | python3 -c 'import json,sys; print(json.load(sys.stdin)["packages"][0]["version"])')"
+          python_version="$(python3 - <<'PY'
+          import tomllib
+          with open("pyproject.toml", "rb") as fh:
+              print(tomllib.load(fh)["project"]["version"])
+          PY
+          )"
+          if [ "$version" != "$python_version" ]; then
+            echo "Cargo.toml version $version does not match pyproject.toml version $python_version" >&2
+            exit 1
+          fi
+          if ! grep -Eq "^## $version([[:space:]-]|$)" CHANGELOG.md; then
+            echo "CHANGELOG.md must contain a release entry for $version" >&2
+            exit 1
+          fi
+
+          crate_published=0
+          if cargo search '^lkh-rs$' --limit 20 | grep -Eq '^lkh-rs = "'"$version"'"'; then
+            crate_published=1
+          fi
+
+          python_published=0
+          status="$(curl -fsS -o /tmp/pypi-lkh-rs.json -w '%{http_code}' https://pypi.org/pypi/lkh-rs/json || true)"
+          if [ "$status" = "200" ] && python3 - "$version" /tmp/pypi-lkh-rs.json <<'PY'
+          import json
+          import sys
+          version = sys.argv[1]
+          path = sys.argv[2]
+          with open(path, "r", encoding="utf-8") as fh:
+              data = json.load(fh)
+          raise SystemExit(0 if version in data.get("releases", {}) else 1)
+          PY
+          then
+            python_published=1
+          elif [ "$status" != "200" ] && [ "$status" != "404" ]; then
+            echo "Could not query PyPI for lkh-rs: HTTP $status" >&2
+            exit 1
+          fi
+
+          if [ "$crate_published" -ne "$python_published" ]; then
+            echo "Version $version is published on only one registry; refusing to continue" >&2
+            exit 1
+          fi
+
+          publish=1
+          if [ "$crate_published" -eq 1 ] && [ "$python_published" -eq 1 ]; then
+            publish=0
+          fi
+
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          echo "publish=$publish" >> "$GITHUB_OUTPUT"
+
+  python-wheels:
+    name: Python wheels (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    needs: [release-plan]
+    if: needs.release-plan.outputs.publish == '1'
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - name: Install bindgen dependencies (Ubuntu)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
+
+      - name: Install bindgen dependencies (Windows)
+        if: runner.os == 'Windows'
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          version: "18"
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: --release --features python-extension-module --compatibility pypi --out dist
+          manylinux: "2014"
+
+      - name: Upload wheel artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-wheels-${{ runner.os }}
+          path: dist/*.whl
+
+  python-sdist:
+    name: Python sdist
+    runs-on: ubuntu-latest
+    needs: [release-plan]
+    if: needs.release-plan.outputs.publish == '1'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build source distribution
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+
+      - name: Upload sdist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-sdist
+          path: dist/*.tar.gz
+
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [release-plan, python-wheels, python-sdist]
+    if: needs.release-plan.outputs.publish == '1'
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Download Python artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+
+  crates-io:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: [release-plan, pypi]
+    if: needs.release-plan.outputs.publish == '1'
+    environment: crates.io
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Install bindgen dependencies
+        run: sudo apt-get update && sudo apt-get install -y clang libclang-dev
+
+      - name: Package verification
+        run: cargo package
+
+      - name: Publish
+        run: cargo publish --token "${{ secrets.CARGO_REGISTRY_TOKEN }}"

lkh_rs-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# Python extension build artifacts produced by maturin develop
+__pycache__/
+*.py[cod]
+python/lkh_rs/_native*.so
+
+# LKH C sources may be built manually while debugging.
+source_code/LKH-*/LKH
+source_code/LKH-*/SRC/OBJ/
+
+.idea
+.vscode

lkh_rs-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+## 0.1.0 - 2026-07-09
+
+Initial public release candidate.
+
+### Added
+
+- Safe serialized Rust API around LKH's process-global C solver state.
+- Parameter-file solving through `solve_parameter_file`.
+- Programmatic in-memory routing API with typed Python and Rust facades.
+- Python package built with PyO3 and maturin.
+- FastAPI JSON demo backend with a browser route visualizer and real LKH case
+  catalog loading.
+- Rust examples and Python examples for programmatic solves.
+- CI workflows for Rust checks/tests and Python wheel builds across Linux,
+  macOS, and Windows.
+- Release workflow for publishing Python wheels/sdist to PyPI and the Rust
+  crate to crates.io from `main` after version and registry-state checks.
+
+### Fixed
+
+- Reset LKH file-related globals before each parameter-file solve so settings
+  such as `INITIAL_TOUR_FILE` cannot leak between cases.
+- Release the Python GIL while native solves are running.
+- Report mTSP `MINMAX` objectives using LKH's penalty objective rather than the
+  aggregate tour cost in the FastAPI demo.
+
+### Changed
+
+- Documented FastAPI as the browser integration path and recorded current Wasm
+  limitations.
+- Documented subprocess isolation requirements for service workloads because
+  upstream LKH can still terminate the current process on some malformed inputs.