Use scikit build

Author: haochengxia

pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["scikit-build-core>=0.10", "pybind11"]
+build-backend = "scikit_build_core.build"
+
+
+[project]
+name = "libcachesim"
+version = "0.0.1"
+description="Python bindings for libCacheSim"
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.optional-dependencies]
+test = ["pytest"]
+
+
+[tool.scikit-build]
+wheel.expand-macos-universal-tags = true
+minimum-version = "build-system.requires"
+
+
+[tool.pytest.ini_options]
+minversion = "8.0"
+addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
+xfail_strict = true
+log_cli_level = "INFO"
+filterwarnings = [
+  "error",
+  "ignore::pytest.PytestCacheWarning",
+]
+testpaths = ["tests"]
+
+
+[tool.cibuildwheel]
+build-frontend = "build[uv]"
+test-command = "pytest {project}/tests"
+test-extras = ["test"]
+
+[tool.cibuildwheel.pyodide]
+build-frontend = {name = "build", args = ["--exports", "whole_archive"]}
+
+[tool.ruff.lint]
+extend-select = [
+  "B",           # flake8-bugbear
+  "I",           # isort
+  "ARG",         # flake8-unused-arguments
+  "C4",          # flake8-comprehensions
+  "EM",          # flake8-errmsg
+  "ICN",         # flake8-import-conventions
+  "G",           # flake8-logging-format
+  "PGH",         # pygrep-hooks
+  "PIE",         # flake8-pie
+  "PL",          # pylint
+  "PT",          # flake8-pytest-style
+  "PTH",         # flake8-use-pathlib
+  "RET",         # flake8-return
+  "RUF",         # Ruff-specific
+  "SIM",         # flake8-simplify
+  "T20",         # flake8-print
+  "UP",          # pyupgrade
+  "YTT",         # flake8-2020
+  "EXE",         # flake8-executable
+  "NPY",         # NumPy specific rules
+  "PD",          # pandas-vet
+]
+ignore = [
+  "PLR09",    # Too many X
+  "PLR2004",  # Magic comparison
+]
+isort.required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["T20"]

python/CMakeLists.txt

@@ -0,0 +1,30 @@
+# Modified from https://github.com/pybind/scikit_build_example/blob/master/CMakeLists.txt
+cmake_minimum_required(VERSION 3.15...3.27)
+
+project(
+  ${SKBUILD_PROJECT_NAME}
+  VERSION ${SKBUILD_PROJECT_VERSION}
+  LANGUAGES CXX)
+
+# find python and pybind11
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(pybind11 CONFIG REQUIRED)
+
+# add libCacheSim library
+add_subdirectory(.. ${CMAKE_CURRENT_BINARY_DIR}/libCacheSim)
+
+# create python module
+python_add_library(_libcachesim MODULE 
+    src/pylibcachesim.cpp 
+    WITH_SOABI
+)
+
+target_link_libraries(_libcachesim PRIVATE 
+    pybind11::headers
+    libCacheSim  # link libCacheSim
+)
+
+target_compile_definitions(_libcachesim PRIVATE VERSION_INFO=${PROJECT_VERSION})
+
+# install to wheel directory
+install(TARGETS _libcachesim DESTINATION libcachesim)

python/libcachesim/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+
+# TODO(haocheng): add meaningful methods
+from ._libcachesim import *
+
+__all__ = ["__doc__", "__version__"]

python/libcachesim/__init__.pyi

@@ -0,0 +1,20 @@
+"""
+libCacheSim Python bindings
+--------------------------
+
+.. currentmodule:: libcachesim
+
+.. autosummary::
+    :toctree: _generate
+
+    TODO(haocheng): add meaningful methods
+    add
+    subtract
+"""
+
+def add(i: int, j: int) -> int:
+    """
+    Add two numbers
+
+    Some other explanation about the add function.
+    """

python/src/pylibcachesim.cpp

@@ -0,0 +1,45 @@
+#include <pybind11/pybind11.h>
+#include "libCacheSim.h"
+
+#define STRINGIFY(x) #x
+#define MACRO_STRINGIFY(x) STRINGIFY(x)
+
+// int add(int i, int j) {
+//     return i + j;
+// }
+
+namespace py = pybind11;
+
+PYBIND11_MODULE(_libcachesim, m) {
+    m.doc() = R"pbdoc(
+        libCacheSim Python bindings
+        --------------------------
+
+        .. currentmodule:: libcachesim
+
+        .. autosummary::
+           :toctree: _generate
+
+           TODO(haocheng): add meaningful methods
+           add
+           subtract
+    )pbdoc";
+
+    // m.def("add", &add, R"pbdoc(
+    //     Add two numbers
+
+    //     Some other explanation about the add function.
+    // )pbdoc");
+
+    // m.def("subtract", [](int i, int j) { return i - j; }, R"pbdoc(
+    //     Subtract two numbers
+
+    //     Some other explanation about the subtract function.
+    // )pbdoc");
+
+#ifdef VERSION_INFO
+    m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
+#else
+    m.attr("__version__") = "dev";
+#endif
+}