Merge branch 'master' into use-auditwheel

Author: jameslamb

build-python.sh

@@ -289,11 +289,11 @@ create_isolated_source_dir
 
 cd ./lightgbm-python
 
-# installation involves building the wheel + `pip install`-ing it
+# if 'install' was passed, choose the type of package to build and install
 if test "${INSTALL}" = true; then
     if test "${PRECOMPILE}" = true; then
-        BUILD_SDIST=true
-        BUILD_WHEEL=false
+        BUILD_SDIST=false
+        BUILD_WHEEL=true
         BUILD_ARGS=""
         rm -rf \
             ./cmake \
@@ -302,16 +302,22 @@ if test "${INSTALL}" = true; then
             ./include \
             ./src \
             ./swig
-        # use regular-old setuptools for these builds, to avoid
-        # trying to recompile the shared library
+        # avoid trying to recompile, just use hatchling and copy in relevant files
         sed -i.bak -e '/start:build-system/,/end:build-system/d' pyproject.toml
-        # shellcheck disable=SC2129
-        echo '[build-system]' >> ./pyproject.toml
-        echo 'requires = ["setuptools"]' >> ./pyproject.toml
-        echo 'build-backend = "setuptools.build_meta"' >> ./pyproject.toml
-        echo "" >> ./pyproject.toml
-        echo "recursive-include lightgbm *.dll *.dylib *.so" > ./MANIFEST.in
-        echo "" >> ./MANIFEST.in
+
+# replace build backend configuration
+cat >> ./pyproject.toml <<EOF
+
+[build-system]
+requires = ["hatchling>=1.27.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+# do not consider .gitignore when choosing files to include / exclude
+ignore-vcs = true
+packages = ["lightgbm"]
+
+EOF
         mkdir -p ./lightgbm/lib
         if test -f ../lib_lightgbm.so; then
             echo "[INFO] found pre-compiled lib_lightgbm.so"
@@ -338,7 +344,11 @@ if test "${INSTALL}" = true; then
             exit 1
         fi
         rm -f ./*.bak
-    else
+    fi
+
+    # at this point, if 'install' was passed but the package type wasn't indicated, prefer wheel
+    if test "${BUILD_SDIST}" = false && test "${BUILD_WHEEL}" = false; then
+        echo "[INFO] 'install' passed but no package type ('bdist_wheel', 'sdist') chosen. Defaulting to 'bdist_wheel'."
         BUILD_SDIST="false"
         BUILD_WHEEL="true"
     fi
@@ -366,22 +376,19 @@ fi
 
 if test "${INSTALL}" = true; then
     echo "[INFO] --- installing lightgbm ---"
-    cd ../dist
+    cd ..
     if test "${BUILD_WHEEL}" = true; then
-        PACKAGE_NAME="$(echo lightgbm*.whl)"
+        PACKAGE_FILE="$(echo dist/lightgbm*.whl)"
     else
-        PACKAGE_NAME="$(echo lightgbm*.tar.gz)"
+        PACKAGE_FILE="$(echo dist/lightgbm*.tar.gz)"
     fi
-    # ref for use of '--find-links': https://stackoverflow.com/a/52481267/3986677
     # shellcheck disable=SC2086
     pip install \
         ${PIP_INSTALL_ARGS} \
         --force-reinstall \
         --no-cache-dir \
         --no-deps \
-        --find-links=. \
-        "${PACKAGE_NAME}"
-    cd ../
+        "${PACKAGE_FILE}"
 fi
 
 echo "[INFO] cleaning up"

docs/GPU-Tutorial.rst

@@ -73,8 +73,8 @@ If you want to use the Python interface of LightGBM, you can install it now (alo
 
 ::
 
-    sudo apt-get -y install python-pip
-    sudo -H pip install setuptools numpy scipy scikit-learn -U
+    sudo apt-get -y install python3-pip python3-venv
+    sudo -H pip install numpy scipy scikit-learn -U
     sudo sh ./build-python.sh install --precompile
 
 You need to set an additional parameter ``"device" : "gpu"`` (along with your other options like ``learning_rate``, ``num_leaves``, etc) to use GPU in Python.

python-package/pyproject.toml

@@ -3,7 +3,6 @@
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
@@ -22,7 +21,10 @@ dependencies = [
     "scipy"
 ]
 description = "LightGBM Python-package"
-license = {file = "LICENSE"}
+license = "MIT"
+license-files = [
+    "LICENSE"
+]
 maintainers = [
   {name = "Yu Shi", email = "[email protected]"}
 ]
@@ -60,7 +62,7 @@ changelog = "https://github.com/microsoft/LightGBM/releases"
 # start:build-system
 [build-system]
 
-requires = ["scikit-build-core>=0.10.1"]
+requires = ["scikit-build-core>=0.11.0"]
 build-backend = "scikit_build_core.build"
 
 # based on https://github.com/scikit-build/scikit-build-core#configuration