Use setuptools-scm for single-source version management

Author: statmlben

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rehline"
-version = "0.1.2"
+dynamic = ["version"]
 description = "Regularized Composite ReLU-ReHU Loss Minimization with Linear Computation and Linear Convergence"
 authors = [
   {name = "Ben Dai", email = "bendai@cuhk.edu.hk"},
@@ -18,6 +18,9 @@ dependencies = [
     "scikit-learn >= 1.2.2"
 ]
 
+[tool.setuptools_scm]
+tag_prefix = "v"
+
 [pyproject.urls]
 homepage = "https://rehline.github.io/"
 repository = "https://github.com/softmin/ReHLine-python"
@@ -40,5 +43,5 @@ python_classes = ["Test*"]
 python_functions = ["test_*"]
 
 [build-system]
-requires = ["requests ~= 2.31.0", "pybind11 ~= 3.0.0", "setuptools >= 80.0.0", "wheel >= 0.42.0"]
+requires = ["requests ~= 2.31.0", "pybind11 ~= 3.0.0", "setuptools >= 80.0.0", "wheel >= 0.42.0", "setuptools-scm >= 8.0"]
 build-backend = "setuptools.build_meta"

rehline/__init__.py

@@ -1,24 +1,37 @@
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("rehline")
+except PackageNotFoundError:
+    __version__ = "0.0.0.dev0"
+
 # Import from internal C++ module
-from ._base import (ReHLine_solver, _BaseReHLine,
-                    _make_constraint_rehline_param, _make_loss_rehline_param)
+from ._base import (
+    ReHLine_solver,
+    _BaseReHLine,
+    _make_constraint_rehline_param,
+    _make_loss_rehline_param,
+)
 from ._class import CQR_Ridge, ReHLine, plqERM_Ridge, plqERM_ElasticNet
 from ._internal import rehline_internal, rehline_result
 from ._path_sol import plqERM_Ridge_path_sol
 from ._sklearn_mixin import plq_Ridge_Classifier, plq_Ridge_Regressor
 from ._mf_class import plqMF_Ridge
-from ._data import make_mf_dataset 
+from ._data import make_mf_dataset
 from ._loss import ReHLoss
 
-__all__ = ("_BaseReHLine",
-           "ReHLine_solver",
-           "ReHLine",
-           "plqERM_Ridge",
-           "CQR_Ridge",
-           "plqERM_ElasticNet",
-           "plqMF_Ridge",
-           "plqERM_Ridge_path_sol",
-           "plq_Ridge_Classifier",
-           "plq_Ridge_Regressor",
-           "_make_loss_rehline_param",
-           "_make_constraint_rehline_param",
-           "make_mf_dataset")
+__all__ = (
+    "_BaseReHLine",
+    "ReHLine_solver",
+    "ReHLine",
+    "plqERM_Ridge",
+    "CQR_Ridge",
+    "plqERM_ElasticNet",
+    "plqMF_Ridge",
+    "plqERM_Ridge_path_sol",
+    "plq_Ridge_Classifier",
+    "plq_Ridge_Regressor",
+    "_make_loss_rehline_param",
+    "_make_constraint_rehline_param",
+    "make_mf_dataset",
+)

setup.py

@@ -5,8 +5,9 @@
 import requests
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 from setuptools import setup
+from setuptools_scm import get_version
 
-__version__ = "0.1.2"
+__version__ = get_version(root=".", relative_to=__file__)
 
 # The main interface is through Pybind11Extension.
 # * You can add cxx_std=11/14/17, and then build_ext can be removed.
@@ -20,6 +21,7 @@
 # The directory that contains setup.py
 SETUP_DIRECTORY = Path(__file__).resolve().parent
 
+
 # Download Eigen source files
 # Modified from https://github.com/tohtsky/irspack/blob/main/setup.py
 class get_eigen_include(object):
@@ -51,14 +53,16 @@ def __str__(self) -> str:
 
         return target_dir.name
 
+
 ext_modules = [
-    Pybind11Extension("rehline._internal",
+    Pybind11Extension(
+        "rehline._internal",
         ["src/rehline.cpp"],
         include_dirs=[get_eigen_include(), "src"],
         depends=["src/rehline.h"],
         # Example: passing in the version to the compiled code
-        define_macros=[('VERSION_INFO', __version__)],
-        ),
+        define_macros=[("VERSION_INFO", __version__)],
+    ),
 ]
 
 setup(
@@ -80,4 +84,4 @@ def __str__(self) -> str:
 )
 
 ## build .so file
-## $ c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) ./src/rehline.cpp -o _internal$(python3-config --extension-suffix)
+## $ c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) ./src/rehline.cpp -o _internal$(python3-config --extension-suffix)