MAINT use setuptools_scm (#81)

Author: glemaitre

.gitignore

@@ -73,3 +73,6 @@ target/
 .DS_Store
 .AppleDouble
 .LSOverride
+
+# auto-generated files
+skltemplate/_version.py

doc/conf.py

@@ -8,12 +8,13 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-from skltemplate import __version__
+from importlib.metadata import version as get_version
 
 project = "Scikit-learn Project Template"
 copyright = "2016, V. Birodkar"
 author = "V. Birodkar"
-release = __version__
+release = get_version('skltemplate')
+version = ".".join(release.split(".")[:3])
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

doc/quick_start.rst

@@ -148,7 +148,7 @@ Publish your package
 ====================
 
 .. _PyPi: https://packaging.python.org/tutorials/packaging-projects/
-.. _conda-foge: https://conda-forge.org/
+.. _conda-forge: https://conda-forge.org/
 
 You can make your package available through PyPi_ and conda-forge_. Refer to
 the associated documentation to be able to upload your packages such that

doc/user_guide.rst

@@ -35,7 +35,7 @@ The use case is the following:
 
 In addition, scikit-learn provides a
 mixin_, i.e. :class:`sklearn.base.TransformerMixin`, which
-implement the combination of ``fit`` and ``transform`` called ``fit_transform``::
+implement the combination of ``fit`` and ``transform`` called ``fit_transform``.
 
 One can import the mixin class as::
 

pixi.lock

@@ -1,6 +1,10 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm[toml]>=8"]
+build-backend = "setuptools.build_meta"
+
 [project]
 name = "skltemplate"
-version = "0.1.0"
+dynamic = ["version"]
 authors = [
   { name="Vighnesh Birodkar", email="vighneshbirodkar@nyu.edu" },
   { name="Guillaume Lemaitre", email="g.lemaitre58@gmail.com" },
@@ -28,6 +32,9 @@ classifiers = [
 Homepage = "https://github.com/scikit-learn-contrib/project-template"
 Issues = "https://github.com/scikit-learn-contrib/project-template/issues"
 
+[tool.setuptools_scm]
+version_file = "skltemplate/_version.py"
+
 [tool.pixi.project]
 channels = ["conda-forge"]
 platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]
@@ -60,6 +67,7 @@ test = { cmd = "pytest -vsl --cov=skltemplate --cov-report=xml skltemplate" }
 matplotlib = "*"
 numpydoc = "*"
 pydata-sphinx-theme = "*"
+setuptools-scm = ">=8"  # needed for the versioning
 sphinx = "*"
 sphinx-gallery = "*"
 sphinx-prompt = "*"
@@ -84,6 +92,7 @@ exclude = '''
   | \.vscode
 )/
 '''
+force-exclude = "skltemplate/_version.py"
 
 [tool.ruff]
 # max line length for black
@@ -96,6 +105,7 @@ exclude=[
     "doc/_build",
     "doc/auto_examples",
     "build",
+    "skltemplate/_version.py",
 ]
 
 [tool.ruff.lint]