ikat 0.2.1__tar.gz

ikat-0.2.1/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: ci
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Venv + build deps
+        # maturin develop refuses a bare runner python: it wants a
+        # virtualenv. We make one and address it explicitly — no
+        # activation, so this works identically on all three shells.
+        run: |
+          python -m venv .venv
+          if [ -d .venv/Scripts ]; then VENV_BIN="$PWD/.venv/Scripts";
+          else VENV_BIN="$PWD/.venv/bin"; fi
+          echo "VENV_BIN=$VENV_BIN" >> "$GITHUB_ENV"
+          "$VENV_BIN"/python -m pip install -q "maturin>=1.15,<2" "pytest>=8" "mcp>=1,<2"
+      - name: Rust tests
+        run: cargo test --locked
+      - name: Build module
+        run: '"$VENV_BIN"/python -m maturin develop'
+      - name: Python tests
+        run: '"$VENV_BIN"/python -m pytest tests/'
+
+  tex:
+    # Compile check on real TeX Live (Ubuntu apt packages):
+    # the demo and the showcase paper must build with
+    # zero undefined citations.
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Install TeX Live
+        run: >
+          sudo apt-get update -q &&
+          sudo apt-get install -y -q
+          texlive-latex-base texlive-latex-recommended
+          texlive-pictures texlive-publishers
+      - name: Venv + build deps
+        run: |
+          python -m venv .venv
+          if [ -d .venv/Scripts ]; then VENV_BIN="$PWD/.venv/Scripts";
+          else VENV_BIN="$PWD/.venv/bin"; fi
+          echo "VENV_BIN=$VENV_BIN" >> "$GITHUB_ENV"
+          "$VENV_BIN"/python -m pip install -q "maturin>=1.15,<2" "mcp>=1,<2"
+      - name: Build module
+        run: '"$VENV_BIN"/python -m maturin develop'
+      - name: Build demo
+        run: '"$VENV_BIN"/python examples/demo.py'
+      - name: Build showcase paper
+        run: '"$VENV_BIN"/python examples/ikat-paper/build.py'
+      - name: No undefined citations
+        run: |
+          if grep -rE "There were undefined references|Citation .* undefined|Undefined control sequence" \
+              examples/demo-out examples/ikat-paper/out --include="*.log"; then
+            echo "::error::TeX errors in build logs"; exit 1;
+          fi

ikat-0.2.1/.github/workflows/pages.yml

@@ -0,0 +1,96 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v4
+
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+
+      - name: Validate static site and local references
+        shell: bash
+        run: |
+          test -s site/index.html
+          test -s site/styles.css
+          test -s site/script.js
+          python - <<'PY'
+          from html.parser import HTMLParser
+          from pathlib import Path
+          from urllib.parse import unquote, urlsplit
+          import re
+
+          root = Path("site")
+          html = (root / "index.html").read_text(encoding="utf-8")
+
+          class PageParser(HTMLParser):
+              def __init__(self):
+                  super().__init__()
+                  self.ids = set()
+                  self.refs = []
+              def handle_starttag(self, tag, attrs):
+                  attrs = dict(attrs)
+                  if "id" in attrs:
+                      self.ids.add(attrs["id"])
+                  for key in ("href", "src"):
+                      value = attrs.get(key, "")
+                      if value:
+                          self.refs.append(value)
+
+          page = PageParser()
+          page.feed(html)
+          errors = []
+          for ref in page.refs:
+              url = urlsplit(ref)
+              if url.scheme or url.netloc:
+                  continue
+              if url.fragment and not url.path and url.fragment not in page.ids:
+                  errors.append(f"missing in-page target #{url.fragment}")
+                  continue
+              if not url.path:
+                  continue
+              target = root / unquote(url.path)
+              if not target.is_file():
+                  errors.append(f"missing local file for {ref}")
+
+          css = (root / "styles.css").read_text(encoding="utf-8")
+          for raw in re.findall(r"url\([\"']?([^\)\"']+)", css):
+              if raw.startswith(("http:", "https:", "data:")):
+                  continue
+              if not (root / unquote(raw)).is_file():
+                  errors.append(f"missing CSS asset {raw}")
+
+          if "<title>ikat" not in html:
+              errors.append("page title is missing")
+          if errors:
+              raise SystemExit("\n".join(errors))
+          print(f"Static site OK: {len(page.ids)} ids, {len(page.refs)} HTML references, CSS assets present")
+          PY
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ikat-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: release
+
+# Ship a version: push tag vX.Y.Z (must match Cargo.toml + pyproject).
+# PyPI wheels and the crates.io publish run in parallel.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+jobs:
+  check-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Tag matches package versions
+        run: |
+          test "v$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml)" = "${{ github.ref_name }}" \
+            || { echo "::error::tag does not match Cargo.toml"; exit 1; }
+          test "v$(sed -n 's/^version = "\(.*\)"/\1/p' pyproject.toml)" = "${{ github.ref_name }}" \
+            || { echo "::error::tag does not match pyproject.toml"; exit 1; }
+
+  pypi-wheels:
+    needs: check-tag
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: --release --out dist --find-interpreter
+          manylinux: auto
+      - name: Build sdist (linux only)
+        if: matrix.os == 'ubuntu-latest'
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}
+          path: dist/
+
+  pypi-publish:
+    needs: pypi-wheels
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # trusted publishing (OIDC): no API token
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        # Trusted publishing: the ikat PyPI project needs this repo +
+        # workflow registered as a (pending) publisher. No password.
+
+  crates-publish:
+    needs: check-tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Publish to crates.io
+        run: cargo publish --locked
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

ikat-0.2.1/.gitignore

@@ -0,0 +1,26 @@
+/target/
+.venv/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.pdb
+*.so
+*.egg-info/
+dist/
+.pytest_cache/
+examples/demo-out/
+examples/ikat-paper/out/
+*.aux
+*.log
+*.out
+*.toc
+*.bbl
+*.blg
+*.pdf
+!examples/*.pdf
+!site/assets/ikat-paper.pdf
+
+# Another agent/design round scratch space (impeccable) — not part of ikat
+PRODUCT.md
+.impeccable/