Remove versioneer (#16)

* Remove versioneer

* Remove versioneer

* Changelog

* Changelog

* Clarify setup.py behaviour

* lint

* Cleanup

* Remove platform dependency

* Fix bash

* Don't track `_version.py` since it is now build time

Author: hejamu

.gitignore

@@ -20,6 +20,7 @@ __pycache__/
 build/
 dist/
 sg_execution_times.rst
+_version.py
 
 # Allow scatterkit share text files
 !src/scatterkit/share/*.dat

CHANGELOG.rst

@@ -13,6 +13,7 @@ Unreleased
 ----------
 Henrik Stooß
 
+- Removed versioneer and switched to setuptools_scm for version management (#16)
 - Migrate the doc dict over from MAICoS (#15)
 
 v0.1 (2025/11/11)

MANIFEST.in

@@ -7,6 +7,7 @@ prune docs
 prune examples
 prune tests
 prune developer
+prune .github
 
 exclude .codecov.yml
 exclude .gitattributes

pyproject.toml

@@ -12,9 +12,8 @@ requires = [
     # disabling build isolation.
     "numpy>=2.0.0",
     # Set to minimum version of setuptools that allows pyproject.toml
-    "setuptools>=77",
-    "setuptools-git-versioning<2",
-    "versioneer[toml]",
+    "setuptools>=80",
+    "setuptools_scm >= 8",
     "wheel",
 ]
 build-backend = "setuptools.build_meta"
@@ -72,7 +71,7 @@ scatterkit = "scatterkit.__main__:main"
 
 [tool.check-manifest]
 # ignore files missing in VCS
-ignore = ["src/scatterkit/lib/_cmath.c"]
+ignore = ["src/scatterkit/lib/_cmath.c", "src/scatterkit/_version.py"]
 
 [tool.mypy]
 exclude = ["docs/src/examples"]
@@ -98,7 +97,7 @@ addopts = [
 ]
 
 [tool.ruff]
-exclude = ["versioneer.py", "docs/src/examples/**", "src/scatterkit/_version.py"]
+exclude = ["docs/src/examples/**", "src/scatterkit/_version.py"]
 line-length = 88
 
 [tool.ruff.lint]
@@ -151,9 +150,5 @@ docstring-code-format = true
 [tool.setuptools.packages.find]
 where = ["src"]
 
-[tool.versioneer]
-VCS = "git"
-style = "pep440"
-versionfile_source = "src/scatterkit/_version.py"
-versionfile_build = "scatterkit/_version.py"
-tag_prefix = "v"
+[tool.setuptools_scm]
+version_file = "src/scatterkit/_version.py"

setup.py

@@ -19,11 +19,8 @@
 from pathlib import Path
 
 import numpy as np
-import versioneer
 from setuptools import Extension, setup
 
-VERSION = versioneer.get_version()
-
 
 def hasfunction(cc, funcname, include=None, extra_postargs=None):
     """Check for function.
@@ -92,7 +89,16 @@ def detect_openmp():
     mathlib = [] if os.name == "nt" else ["m"]
 
     has_openmp = detect_openmp()
-    # If we are building a source distribution, the c code is already generated
+
+    # There are two cases to consider when running setup.py:
+    # 1. We are building from source, so we need cython to generate the .c files
+    #    from the .pyx files.
+    # 2. we are building from a source distribution (sdist), in which case the
+    #    .c files are included and we don't need Cython.
+    # If we are installing from a wheel, the binary is already built and the
+    # setup.py is not run at all.
+    # We can detect a sdist by checking for the presence of a setup.cfg file,
+    # which is generated by setuptools when building the sdist.
     use_cython = not Path("./setup.cfg").exists()
     source_suffix = ".pyx" if use_cython else ".c"
 
@@ -120,4 +126,4 @@ def detect_openmp():
                 if not (Path(source).exists() and os.access(source, os.R_OK)):
                     raise OSError(f"Source file {source!r} not found.")
 
-    setup(cmdclass=versioneer.get_cmdclass(), version=VERSION, ext_modules=extensions)
+    setup(use_scm_version=True, ext_modules=extensions)

src/scatterkit/__init__.py

@@ -2,14 +2,11 @@
 
 __authors__ = "MAICoS Developer Team"
 
-from ._version import get_versions
+#: Version information for Scatterkit, following :pep:`440`
+#: and `semantic versioning <http://semver.org/>`_.
+from ._version import __version__  # noqa: F401
 from .diporderstructurefactor import DiporderStructureFactor
 from .rdfdiporder import RDFDiporder
 from .saxs import Saxs
 
-#: Version information for Scatterkit, following :pep:`440`
-#: and `semantic versioning <http://semver.org/>`_.
-__version__ = get_versions()["version"]
-del get_versions
-
 __all__ = ["Saxs", "DiporderStructureFactor", "RDFDiporder"]