Add git-based dynamic versioning with setuptools-scm (#165)

Author: EiffL

.github/workflows/python_package.yaml

@@ -24,6 +24,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          submodules: recursive
+          fetch-tags: true
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v6
@@ -40,7 +44,6 @@ jobs:
 
       - name: Test with pytest
         run: |
-          git submodule update --init --recursive
           pytest -vv --durations=100 --randomly-seed=42
 
   build-status:

.gitignore

@@ -26,6 +26,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+jax_galsim/_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

jax_galsim/__init__.py

@@ -1,3 +1,8 @@
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.1.dev0"
+
 # Exception and Warning classes
 from .errors import GalSimError, GalSimRangeError, GalSimValueError
 from .errors import GalSimKeyError, GalSimIndexError, GalSimNotImplementedError

pyproject.toml

@@ -1,6 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=45",
+    "setuptools-scm>=8",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -10,7 +11,7 @@ authors = [
     {name = "GalSim Developers"},
 ]
 description = "The modular galaxy image simulation toolkit, but in JAX"
-version = "0.0.1rc1"
+dynamic = ["version"]
 license = {file = "LICENSE"}
 readme = "README.md"
 dependencies = [
@@ -31,6 +32,10 @@ home = "https://github.com/GalSim-developers/JAX-GalSim"
 [tool.setuptools.packages.find]
 include = ["jax_galsim*"]
 
+[tool.setuptools-scm]
+write_to = "jax_galsim/_version.py"
+fallback_version = "0.0.1.dev0"
+
 [tool.ruff.lint]
 select = ["E", "F", "I", "W"]
 ignore = ["C901", "E203", "E501"]