feat: Add pybind11 bindings, scikit-build-core setup, and CI workflow for Python package

- Implemented initial pybind11 class bindings to expose C++ API to Python.
- Integrated scikit-build-core by updating CMakeLists.txt and pyproject.toml.
- Added GitHub Actions workflow to build and test the Python package.

Author: AhmedYasserrr

.github/workflows/pip.yml

@@ -0,0 +1,41 @@
+name: Pip
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - dev_py_pkg_build
+
+jobs:
+  build:
+    name: Build on ${{ matrix.platform }} with Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+
+    - name: Upgrade pip, build tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install build scikit-build-core pybind11
+
+    - name: Build and install the package
+      run: |
+        pip install --verbose .
+
+    - name: Test import
+      run: |
+        python -c "import pyectool; print('pyectool imported')"

.gitignore

@@ -1 +1,2 @@
 build/*
+*/__pycache__/*

CMakeLists.txt

@@ -1,26 +1,43 @@
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.15...3.27)
 
-if(${CMAKE_VERSION} VERSION_LESS 3.12)
-	cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
-endif()
+project(
+  ${SKBUILD_PROJECT_NAME}
+  VERSION ${SKBUILD_PROJECT_VERSION}
+  LANGUAGES CXX)
+
+# Required for building Python extension modules via pybind11
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
 
-project(ECTool
-	VERSION 1.0.0
-	DESCRIPTION "ChromeOS EC Tool"
-	LANGUAGES CXX)
+# Find pybind11 (installed via pip/conda or system-wide)
+find_package(pybind11 CONFIG REQUIRED)
 
 if(NOT WIN32)
-	find_package(PkgConfig REQUIRED)
-	pkg_check_modules(libusb REQUIRED libusb-1.0)
-	pkg_check_modules(libftdi1 REQUIRED libftdi1)
+  find_package(PkgConfig REQUIRED)
+  pkg_check_modules(libusb REQUIRED libusb-1.0)
+  pkg_check_modules(libftdi1 REQUIRED libftdi1)
 else()
+
 endif()
 
 set(CMAKE_CXX_STANDARD 17)
 
 add_subdirectory(src/core)
+add_subdirectory(src/bindings)
 add_subdirectory(src/extern)
 
 if(WIN32)
-	add_subdirectory(src/getopt)
+  add_subdirectory(src/getopt)
 endif()
+
+install(
+  TARGETS ectool libectool libectool_py
+  RUNTIME DESTINATION pyectool/bin # ectool CLI binary
+  LIBRARY DESTINATION pyectool # libectool_py.so (shared Python module)
+  ARCHIVE DESTINATION pyectool/lib # libectool.a (static lib)
+)
+
+install(
+  DIRECTORY src/include/
+  DESTINATION pyectool/include
+  FILES_MATCHING
+  PATTERN "libectool.h")

pyectool/__init__.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from .libectool_py import (
+    __doc__,
+    __version__,
+    ascii_mode,
+    auto_fan_control,
+    get_max_non_battery_temperature,
+    get_max_temperature,
+    init,
+    is_on_ac,
+    release,
+    set_fan_duty,
+)
+
+__all__ = [
+    "__doc__",
+    "__version__",
+    "ascii_mode",
+    "auto_fan_control",
+    "get_max_non_battery_temperature",
+    "get_max_temperature",
+    "init",
+    "is_on_ac",
+    "release",
+    "set_fan_duty",
+]

pyectool/__init__.pyi

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+__doc__: str
+__version__: str
+
+def init() -> None: ...
+def release() -> None: ...
+def is_on_ac() -> bool: ...
+def auto_fan_control() -> None: ...
+def set_fan_duty(duty: int) -> None: ...
+def get_max_temperature() -> float: ...
+def get_max_non_battery_temperature() -> float: ...
+
+ascii_mode: bool

pyproject.toml

@@ -4,16 +4,15 @@ build-backend = "scikit_build_core.build"
 
 
 [project]
-name = "libectool"
+name = "pyectool"
 version = "0.0.1"
-description="A shared library (libectool) that exposes ectool functionalities for seamless integration with other applications"
+description="Python bindings for ectool using pybind11, enabling seamless integration with other applications"
 readme = "README.md"
 authors = [
   { name = "Ahmed Gamea", email = "ahmed.gamea@ejust.edu.eg" },
 ]
 
 [tool.scikit-build]
-wheel.expand-macos-universal-tags = true
 minimum-version = "build-system.requires"
 
 [tool.cibuildwheel]

src/bindings/CMakeLists.txt

@@ -0,0 +1,7 @@
+# Create the Python module
+python_add_library(libectool_py MODULE libectool_py.cc WITH_SOABI)
+
+# Link against required libraries
+target_link_libraries(libectool_py PRIVATE pybind11::headers libectool)
+target_include_directories(libectool_py PUBLIC ../include)
+target_compile_definitions(libectool_py PUBLIC VERSION_INFO=${PROJECT_VERSION})

src/bindings/libectool_py.cc

@@ -0,0 +1,31 @@
+#include <pybind11/pybind11.h>
+#include "libectool.h"
+
+#define STRINGIFY(x) #x
+#define MACRO_STRINGIFY(x) STRINGIFY(x)
+
+namespace py = pybind11;
+
+PYBIND11_MODULE(libectool_py, m) {
+    m.doc() = "Python bindings for ectool";
+
+    // Optional: expose init/release explicitly
+    m.def("init", &libectool_init, "Initialize libectool");
+    m.def("release", &libectool_release, "Release libectool");
+
+    // Expose API functions
+    m.def("is_on_ac", &is_on_ac, "Check if on AC power");
+    m.def("auto_fan_control", &auto_fan_control, "Enable automatic fan control");
+    m.def("set_fan_duty", &set_fan_duty, py::arg("duty"), "Set fan duty cycle (0-100)");
+    m.def("get_max_temperature", &get_max_temperature, "Get max temperature");
+    m.def("get_max_non_battery_temperature", &get_max_non_battery_temperature, "Get max non-battery temperature");
+
+    // Expose global variable ascii_mode
+    m.attr("ascii_mode") = py::cast(&ascii_mode, py::return_value_policy::reference);
+
+    #ifdef VERSION_INFO
+    m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
+    #else
+        m.attr("__version__") = "dev";
+    #endif
+}

src/core/CMakeLists.txt

@@ -26,7 +26,7 @@ else()
 endif()
 
 # ============================
-# Add Executable Target: ectool
+# Add Executable Target: ectool (CLI)
 # ============================
 add_executable(ectool ectool.cc ${ECTOOL_COMMON_SOURCES})
 
@@ -53,37 +53,33 @@ endif()
 target_link_libraries(ectool ${libusb_LIBRARIES} ${libftdi1_LIBRARIES})
 
 # ============================
-# Add Shared Library : libectool.so
+# Add STATIC Library : libectool
 # ============================
+add_library(libectool STATIC libectool.cc ${ECTOOL_COMMON_SOURCES})
 
-set(LIBECTOOL_SOURCES ${ECTOOL_COMMON_SOURCES} libectool.cc)
+target_include_directories(libectool PUBLIC ../include ${libusb_INCLUDE_DIRS})
 
-add_library(libectool SHARED ${LIBECTOOL_SOURCES})
-
-target_include_directories(libectool PRIVATE ../include ${libusb_INCLUDE_DIRS})
-
-target_compile_definitions(libectool PRIVATE CHROMIUM_EC EXTERNAL_ECTOOL_BUILD)
+target_compile_definitions(libectool PUBLIC CHROMIUM_EC EXTERNAL_ECTOOL_BUILD)
 
 target_compile_options(
-  libectool PRIVATE -Wno-c99-designator -Wno-address-of-packed-member
-                    -Wno-format-security)
+  libectool PUBLIC -Wno-c99-designator -Wno-address-of-packed-member
+                   -Wno-format-security)
 
-target_link_libraries(libectool PRIVATE ${libusb_LIBRARIES}
-                                        ${libftdi1_LIBRARIES})
+target_link_libraries(libectool PUBLIC ${libusb_LIBRARIES}
+                                       ${libftdi1_LIBRARIES})
 
 if(WIN32)
-  target_compile_definitions(ectool PRIVATE _CRT_SECURE_NO_WARNINGS)
-  target_link_libraries(ectool PRIVATE getopt CrosECDriver
-                                       onecoreuap_apiset.lib)
+  target_compile_definitions(libectool PUBLIC _CRT_SECURE_NO_WARNINGS)
+  target_link_libraries(libectool PUBLIC getopt CrosECDriver
+                                         onecoreuap_apiset.lib)
   if(MSVC)
-    target_compile_options(ectool PRIVATE /FI"..\\include\\win32_shim.h")
+    target_compile_options(libectool PUBLIC /FI"..\\include\\win32_shim.h")
   else()
-    target_compile_options(ectool PRIVATE -include "..\\include\\win32_shim.h")
+    target_compile_options(libectool PUBLIC -include
+                                            "..\\include\\win32_shim.h")
   endif()
-  target_include_directories(ectool PRIVATE ../include/win32)
+  target_include_directories(libectool PUBLIC ../include/win32)
 endif()
 
-set_target_properties(
-  libectool PROPERTIES OUTPUT_NAME "ectool" # Generates `libectool.so` or
-                                            # `libectool.dll`
-)
+set_target_properties(libectool PROPERTIES OUTPUT_NAME ectool
+                                           POSITION_INDEPENDENT_CODE ON)