scikit-sparse · broesler · Feb 11, 2026 · Oct 27, 2025 · Oct 27, 2025 · Oct 27, 2025
diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yml
@@ -0,0 +1,105 @@
+name: Build Check
+
+on:
+  workflow_dispatch:
+  push:
+    branches: 
+      - "build-check"
+      - "release/*"
+
+jobs:
+  build-check:
+    name: Build Check
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install non-python dependencies on mac
+        if: runner.os == 'macOS'
+        run: |
+          brew install suite-sparse
+
+      - name: Install non-python dependencies on linux
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get install libsuitesparse-dev
+
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip
+          pip install build
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+
+      - name: List sdist contents
+        run: |
+          echo "---- Source distribution contents ----"
+          tar -tzf dist/*.tar.gz
+
+      - name: List wheel contents
+        run: |
+          echo "---- Wheel contents ----"
+          unzip -l dist/*.whl
+
+      - name: Check wheel for .c/.pyx (should be excluded)
+        run: |
+          if unzip -l dist/*.whl | grep -E '\.c$|\.pyx$'; then
+            echo "::error::Wheel includes Cython source or C files"
+            exit 1
+          fi
+
+      - name: Setup Micromamba
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          micromamba-version: "latest"
+          init-shell: bash
+
+      - name: Create new conda env and install wheel
+        shell: bash -l {0}  # use bash as a login shell for conda activation
+        run: |
+          micromamba create -n test-wheel python=${{ matrix.python-version }} -y
+          micromamba activate test-wheel
+          micromamba install -c conda-forge suitesparse -y
+          pip install dist/*.whl
+          cd ..  # cd out of repo to avoid import issues
+          pip show scikit-sparse
+          pip show scikit-sparse-dev
+          python -c "import sksparse; print(f'Wheel loaded from: {sksparse.__file__}')"
+
+      - name: Create new conda env and install sdist
+        shell: bash -l {0}  # use bash as a login shell for conda activation
+        run: |
+          micromamba create -n test-sdist python=${{ matrix.python-version }} -y
+          micromamba activate test-sdist
+          micromamba install -c conda-forge suitesparse pytest -y
+          pip install dist/scikit_sparse*.tar.gz
+          SRC_DIR=$(pwd)
+          cd ..  # cd out of repo to avoid import issues
+          pip show scikit-sparse
+          pip show scikit-sparse-dev
+          python -c "import sksparse; print(f'sdist loaded from: {sksparse.__file__}')"
+          # Run tests on the installed package
+          cp -R ${SRC_DIR}/tests ./tests
+          pytest tests
+
+      - name: Upload built artifact
+        uses: actions/upload-artifact@v4
+        # Upload only one artifact to avoid redundancy
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.10'
+        with:
+          name: dist
+          path: dist/
diff --git a/.github/workflows/ci-dev.yml b/.github/workflows/ci-dev.yml
@@ -0,0 +1,66 @@
+name: CI Dev Code
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - "dev"
+      - "bugfix/*"
+
+jobs:
+  tests:
+    name: Test Dev Code
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        env:
+          PIP_DISABLE_PIP_VERSION_CHECK: 1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install non-python dependencies on mac
+        if: runner.os == 'macOS'
+        run: |
+          brew install suite-sparse
+
+      - name: Install non-python dependencies on linux
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get install libsuitesparse-dev
+
+      - name: Install dependencies and package
+        run: |
+          pip install --upgrade pip
+          pip install -v -e .[dev]
+
+      - name: Display installed packages
+        run: |
+          python -m pip list
+
+      - name: Run lint
+        run:  ruff check
+
+      - name: Test with pytest
+        run: pytest -v -s
+
+      - name: Build Docs
+        run: |
+          cd doc
+          make SPHINXOPTS=-nW html
+
+      - name: Upload docs as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: scikit-sparse-doc-${{ matrix.os }}-${{ matrix.python-version }}
+          path: doc/_build/html
diff --git a/.github/workflows/ci_test.yml b/.github/workflows/ci_test.yml
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,41 @@
+name: Deploy
+
+on:
+  workflow_dispatch:
+  release:
+    types:
+      - published
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: deploy
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"  # minimum supported version
+
+      - name: Install non-python dependencies on linux
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install libsuitesparse-dev
+
+      - name: Install build tools
+        run: |
+          pip install --upgrade pip
+          pip install build
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,16 @@
 # Project specific files #
 ##########################
 
-scikits/sparse/cholmod.c
 .coverage
 htmlcov/
 .tox
 .cache
+_dev_scripts/
+
+# Cython-generated files
+*.c
+*.cpp
+*.html
 
 # Cribbed from numpy's .gitignore:
 
@@ -63,6 +68,8 @@ _build
 dist
 doc/build
 doc/cdoc/build
+# auto-generated Sphinx files
+doc/**/generated
 # Eggs
 .eggs
 # Egg metadata
@@ -89,4 +96,4 @@ venv
 
 # vscode
 .devcontainer/
-.vscode/
+.vscode/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.7
+    hooks:
+      # Run the linter, but do not make any changes
+      - id: ruff-check
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# The version of the configuration file.
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    # Use a recent Python version
+    python: "mambaforge-22.9"
+
+conda:
+  environment: doc/environment.yaml
+
+sphinx:
+  configuration: doc/conf.py
+
+formats: all
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,5 @@
-Copyright (c) 2009-2018, Joscha Reimer, Alex Grigorievskiy, Antony Lee, Yuri, Leon Barrett, Dag Sverre Seljebotn, Nathaniel Smith, David Cournapeau
+Copyright (C) 2009-2025, The scikit-sparse developers. All rights reserved.
+See pyproject.toml for complete list of contributors.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: