topica 0.1.0__tar.gz

topica-0.1.0/.github/workflows/CI.yml

@@ -0,0 +1,217 @@
+# CI for rustmallet — a PyO3/maturin package producing abi3 wheels.
+#
+# Jobs:
+#   test        — build in dev mode & run pytest on Linux, macOS, Windows
+#   build-wheels — produce abi3 wheels for all target platforms
+#   sdist       — produce a source distribution
+#   release     — publish to PyPI on tag push v*
+#
+# Publishing uses PyPI Trusted Publishing (OIDC) — no API token / secret.
+# One-time setup on PyPI: add a trusted publisher for project "topica"
+# (owner nealcaren, repo topica, workflow CI.yml, environment pypi).
+
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags:    ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+# Minimal permissions by default; individual jobs override as needed.
+permissions:
+  contents: read
+
+# ---------------------------------------------------------------------------
+# Job: test
+# Builds the extension in-place with `maturin develop` and runs pytest.
+# Matrix covers the three major platforms; a single Python version suffices
+# because the wheel is abi3 (CPython >=3.9 compatible).
+# ---------------------------------------------------------------------------
+jobs:
+  test:
+    name: test / ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # Install stable Rust toolchain (required for maturin/pyo3 compilation).
+      - name: Install Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      # `maturin develop` requires an active virtualenv, so create one and use
+      # it for the build + test. A single bash step keeps the venv activated
+      # across the build and test commands (activation does not persist between
+      # steps). `shell: bash` selects Git bash on Windows, so the same
+      # activation path logic works on all three platforms.
+      - name: Build extension and run tests
+        shell: bash
+        run: |
+          python -m venv .venv
+          if [ -f .venv/bin/activate ]; then source .venv/bin/activate; else source .venv/Scripts/activate; fi
+          python -m pip install --upgrade pip
+          pip install maturin numpy pytest
+          maturin develop --features python
+          pytest -q
+
+  # ---------------------------------------------------------------------------
+  # Job: build-wheels
+  # Produces abi3 wheels. Because the wheel is abi3 (tagged cp39-abi3-*), one
+  # build per platform target is sufficient — no Python version matrix needed.
+  #
+  # maturin-action handles QEMU setup automatically for aarch64-linux and
+  # invokes maturin inside the appropriate manylinux container for Linux.
+  # ---------------------------------------------------------------------------
+  build-wheels:
+    name: wheel / ${{ matrix.target }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # ---- Linux x86_64 (manylinux) ----
+          - os: ubuntu-latest
+            target: x86_64
+            manylinux: auto
+
+          # ---- Linux aarch64 (manylinux, cross-compiled via QEMU) ----
+          - os: ubuntu-latest
+            target: aarch64
+            manylinux: auto
+
+          # ---- macOS x86_64 ----
+          - os: macos-latest
+            target: x86_64
+            manylinux: ""
+
+          # ---- macOS aarch64 (Apple Silicon) ----
+          - os: macos-latest
+            target: aarch64
+            manylinux: ""
+
+          # ---- Windows x64 ----
+          - os: windows-latest
+            target: x64
+            manylinux: ""
+
+    steps:
+      - uses: actions/checkout@v4
+
+      # maturin-action provides Rust toolchain internally; explicit install not
+      # needed here, but setup-python IS needed so maturin can find an interpreter
+      # for the abi3 wheel stub.
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          # manylinux is only meaningful on Linux legs; empty string on others.
+          manylinux: ${{ matrix.manylinux || 'auto' }}
+          # --release: optimised build; --out dist: place wheel in dist/;
+          # --features python: enable pyo3/numpy deps (see Cargo.toml).
+          args: --release --out dist --features python
+          # Rust source is at the repo root.
+          working-directory: .
+
+      # Upload each leg's wheel as a separate artifact so the release job can
+      # download them all cleanly.
+      - name: Upload wheel artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel-${{ matrix.target }}-${{ matrix.os }}
+          path: dist/*.whl
+          if-no-files-found: error
+
+  # ---------------------------------------------------------------------------
+  # Job: sdist
+  # Produces a source distribution (required for a complete PyPI release).
+  # ---------------------------------------------------------------------------
+  sdist:
+    name: sdist
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust (stable)
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Build sdist
+        run: maturin sdist --out dist
+
+      - name: Upload sdist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  # ---------------------------------------------------------------------------
+  # Job: release
+  # Runs only when a version tag (v*) is pushed.
+  # Downloads all wheel + sdist artifacts and publishes to PyPI via Trusted
+  # Publishing (OIDC) — no stored token. Requires the one-time PyPI setup noted
+  # at the top of this file.
+  # ---------------------------------------------------------------------------
+  release:
+    name: release (PyPI)
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [build-wheels, sdist]
+
+    # PyPI Trusted Publishing (OIDC): no API token needed. The id-token
+    # permission lets GitHub mint a short-lived OIDC token that PyPI trades for
+    # an upload credential, based on the trusted-publisher entry you configure
+    # on PyPI (project: topica, owner: nealcaren, repo: topica, workflow:
+    # CI.yml, environment: pypi). See README / docs for the one-time setup.
+    permissions:
+      contents: read
+      id-token: write
+
+    # Binding the job to a named environment lets you add approval gates on
+    # PyPI publishes and is the environment referenced in the PyPI config.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/topica
+
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          # Download every artifact produced above into dist/.
+          path: dist
+          merge-multiple: true
+
+      - name: List dist contents
+        run: ls -lh dist/
+
+      # Trusted Publishing: the action detects the OIDC token from the
+      # id-token permission above and uploads without any stored secret.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          skip-existing: true

topica-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "python/**"
+      - "src/**"
+      - ".github/workflows/docs.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Build the extension and deploy the docs
+        shell: bash
+        run: |
+          # maturin develop needs an activated virtualenv; create one and keep it
+          # active for the whole step so the build and mkdocs share it.
+          python -m venv .venv
+          source .venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install maturin numpy
+          pip install -r docs/requirements.txt
+          # force_inspection imports the compiled module, so build it first.
+          maturin develop --release --features python
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          mkdocs gh-deploy --force --no-history

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

@@ -0,0 +1,77 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: ${{ matrix.target }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: write
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            archive: tar.gz
+          - os: macos-13
+            target: x86_64-apple-darwin
+            archive: tar.gz
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            archive: tar.gz
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            archive: zip
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - name: Install musl tools (Linux)
+        if: matrix.target == 'x86_64-unknown-linux-musl'
+        run: sudo apt-get install -y musl-tools
+
+      - name: Build
+        run: cargo build --release --target ${{ matrix.target }}
+
+      - name: Package (Unix)
+        if: matrix.os != 'windows-latest'
+        run: |
+          STAGING="rust-mallet-${{ github.ref_name }}-${{ matrix.target }}"
+          mkdir "$STAGING"
+          for bin in preprocess analyze train show; do
+            cp "target/${{ matrix.target }}/release/$bin" "$STAGING/"
+          done
+          cp README.md "$STAGING/"
+          cp -r examples "$STAGING/"
+          tar -czf "$STAGING.tar.gz" "$STAGING"
+          echo "ASSET=$STAGING.tar.gz" >> $GITHUB_ENV
+
+      - name: Package (Windows)
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: |
+          $staging = "rust-mallet-${{ github.ref_name }}-${{ matrix.target }}"
+          New-Item -ItemType Directory $staging
+          foreach ($bin in @('preprocess','analyze','train','show')) {
+            Copy-Item "target/${{ matrix.target }}/release/$bin.exe" "$staging/"
+          }
+          Copy-Item README.md "$staging/"
+          Copy-Item -Recurse examples "$staging/"
+          Compress-Archive -Path "$staging/*" -DestinationPath "$staging.zip"
+          echo "ASSET=$staging.zip" | Out-File -FilePath $env:GITHUB_ENV -Append
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ${{ env.ASSET }}
+          generate_release_notes: true

topica-0.1.0/.gitignore

@@ -0,0 +1,49 @@
+# Rust build artifacts
+/target/
+
+# Java reference source (not part of the Rust project)
+Mallet/
+
+# Generated corpus and output files
+*.corp
+*.mallet
+topic_word.tsv
+doc_topic.tsv
+
+# Local test and scratch files
+aha.*
+
+# Distribution / wheel output
+dist/
+
+# Compiled Python extension modules (dev builds)
+*.so
+*.pyd
+
+# Python bytecode caches
+__pycache__/
+*.py[cod]
+
+# Virtual environments
+.venv/
+.venv*/
+venv/
+env/
+
+# Egg / setuptools / maturin dev-install artifacts
+*.egg-info/
+*.egg
+
+# Test / type-checker caches
+.pytest_cache/
+.mypy_cache/
+
+# Built documentation site
+/site/
+
+# macOS metadata
+.DS_Store
+parity/*.class
+
+# Claude Code local dir (agent worktrees, etc.)
+.claude/