Use uv for both doc and lib

Author: haochengxia

.github/workflows/build.yml

@@ -7,59 +7,55 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, macos-14]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+    
     steps:
       - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          submodules: recursive
 
-      - name: Init submodules
-        run: git submodule update --init --recursive
-
-      - name: Prepare
-        run: bash src/libCacheSim/scripts/install_dependency.sh
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
 
-      - name: Build main libCacheSim project
-        run: |
-          pushd src/libCacheSim
-          cmake -G Ninja -B build
-          ninja -C build
-          popd
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
 
-      - name: Build libCacheSim-python
+      - name: Build and test with uv
         run: |
-          pip install -e .[dev]
+          uv venv --python ${{ matrix.python-version }}
+          uv pip install -e .[dev]
+          uv run python -c "import libcachesim; print('✓ Import successful for Python ${{ matrix.python-version }} on ${{ matrix.os }}')"
 
       - name: Run tests
         run: |
-          python -m pytest tests/
+          if [ -d "tests" ]; then
+            uv run python -m pytest tests/ -v
+          else
+            echo "No tests directory found, skipping tests"
+          fi
 
   docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
-
-      - name: Cache dependencies
-        uses: actions/cache@v3
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-docs-${{ hashFiles('docs/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-docs-
+          version: "latest"
 
-      - name: Install documentation dependencies
-        run: |
-          pip install -r docs/requirements.txt
+      - name: Set up Python
+        run: uv python install 3.11
 
-      - name: Test documentation build
+      - name: Install documentation dependencies and build
         run: |
           cd docs
-          mkdocs build --clean --strict
+          uv venv
+          uv pip install -r requirements.txt
+          uv run mkdocs build --clean --strict

CMakeLists.txt

@@ -3,6 +3,50 @@ project(libCacheSim-python)
 set(DESCRIPTION "The libCacheSim Python Package")
 set(PROJECT_WEB "http://cachemon.github.io/libCacheSim-python")
 
+# Auto-initialize submodules if not already done
+find_package(Git QUIET)
+if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
+    # Check if submodule is initialized
+    if(NOT EXISTS "${PROJECT_SOURCE_DIR}/src/libCacheSim/CMakeLists.txt")
+        message(STATUS "Initializing git submodules...")
+        execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive
+                        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+                        RESULT_VARIABLE GIT_SUBMOD_RESULT)
+        if(NOT GIT_SUBMOD_RESULT EQUAL "0")
+            message(FATAL_ERROR "git submodule update --init --recursive failed with ${GIT_SUBMOD_RESULT}")
+        endif()
+    endif()
+endif()
+
+# Auto-build libCacheSim if needed
+set(LIBCACHESIM_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src/libCacheSim")
+if(NOT EXISTS "${LIBCACHESIM_SOURCE_DIR}/CMakeLists.txt")
+    message(FATAL_ERROR "libCacheSim submodule not found. Please run 'git submodule update --init --recursive'")
+endif()
+
+# Build libCacheSim first
+set(LIBCACHESIM_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src/libCacheSim/build")
+if(NOT EXISTS "${LIBCACHESIM_BUILD_DIR}/export_vars.cmake")
+    message(STATUS "Building libCacheSim...")
+    execute_process(
+        COMMAND ${CMAKE_COMMAND} -S ${LIBCACHESIM_SOURCE_DIR} -B ${LIBCACHESIM_BUILD_DIR} -G Ninja
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        RESULT_VARIABLE CMAKE_CONFIG_RESULT
+    )
+    if(NOT CMAKE_CONFIG_RESULT EQUAL "0")
+        message(FATAL_ERROR "Failed to configure libCacheSim")
+    endif()
+    
+    execute_process(
+        COMMAND ${CMAKE_COMMAND} --build ${LIBCACHESIM_BUILD_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        RESULT_VARIABLE CMAKE_BUILD_RESULT
+    )
+    if(NOT CMAKE_BUILD_RESULT EQUAL "0")
+        message(FATAL_ERROR "Failed to build libCacheSim")
+    endif()
+endif()
+
 # Note(haocheng): now we still utilize the exported cache from 
 # the main project, which should be deprecated soon 
 

pyproject.toml

@@ -1,5 +1,11 @@
 [build-system]
-requires = ["scikit-build-core>=0.10", "pybind11"]
+requires = [
+    "scikit-build-core>=0.10", 
+    "pybind11",
+    "cmake>=3.15",
+    "ninja; platform_system!='Windows'",
+    "setuptools_scm[toml]>=6.2"
+]
 build-backend = "scikit_build_core.build"
 
 
@@ -36,6 +42,13 @@ dev = [
 
 [tool.scikit-build]
 wheel.expand-macos-universal-tags = true
+build-dir = "build"
+cmake.build-type = "Release"
+cmake.args = ["-G", "Ninja"]
+cmake.define = { CMAKE_OSX_DEPLOYMENT_TARGET = "14.0" }
+cmake.version = ">=3.15"
+cmake.source-dir = "."
+install.strip = false
 
 [tool.pytest.ini_options]
 minversion = "8.0"