Merge pull request #381 from DoubleML/sk-publishing

Add dynamic versioning

Author: SvenKlaassen

.github/workflows/deploy_pkg.yml

@@ -4,6 +4,7 @@ on:
   release:
     types:
       - published
+  workflow_dispatch:
 
 jobs:
   build:
@@ -14,6 +15,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
+          fetch-depth: 0 # Required for dynamic versioning
 
       - name: Install python
         uses: actions/setup-python@v5
@@ -56,11 +58,38 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           repository-url: https://test.pypi.org/legacy/
+          skip-existing: true # Prevents failure on re-runs
+
+  verify-testpypi:
+    name: Verify TestPyPI Install 🕵️
+    needs: publish-to-testpypi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Wait for TestPyPI indexing
+        run: sleep 60
+
+      - name: Install from TestPyPI
+        # --extra-index-url allows pip to find dependencies (pandas, numpy) on the real PyPI
+        if: github.event_name == 'release'
+        run: pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ "DoubleML==${{ github.ref_name }}"
+
+      - name: Install from TestPyPI (workflow_dispatch)
+        # For manual runs, install the latest pre-release version
+        if: github.event_name == 'workflow_dispatch'
+        run: pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ DoubleML
+
+      - name: Import Smoke Test
+        run: python -c "import doubleml; print(f'Successfully imported DoubleML version {doubleml.__version__}')"
 
   publish-to-pypi:
     name: Publish to PyPI 🚀
-    needs: publish-to-testpypi
+    needs: verify-testpypi
     runs-on: ubuntu-latest
+    if: github.event_name == 'release' # Do not publish on workflow_dispatch
     environment:
       name: pypi
       url: https://pypi.org/p/DoubleML
@@ -76,3 +105,22 @@ jobs:
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
+
+  verify-pypi:
+    name: Verify PyPI Install 🕵️
+    needs: publish-to-pypi
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    steps:
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Wait for PyPI indexing
+        run: sleep 60
+
+      - name: Install from PyPI
+        run: pip install "DoubleML==${{ github.ref_name }}"
+
+      - name: Import Smoke Test
+        run: python -c "import doubleml; print(f'Successfully imported DoubleML version {doubleml.__version__}')"

.github/workflows/pytest.yml

@@ -32,7 +32,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
       with:
-        fetch-depth: 2
+        fetch-depth: 0  # allow version retrieval with setuptools_scm
 
     - name: Set up Python ${{ matrix.config.python-version }}
       uses: actions/setup-python@v5

.gitignore

@@ -31,3 +31,6 @@ MANIFEST
 *.vscode
 .flake8
 .coverage
+
+# Setuptools SCM
+doubleml/_version.py

doc/conf.py

@@ -13,6 +13,8 @@
 import os
 import sys
 
+import doubleml
+
 sys.path.insert(0, os.path.abspath(".."))
 
 
@@ -23,7 +25,7 @@
 author = "Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M."
 
 # The full version, including alpha/beta/rc tags
-release = "0.12.dev0"
+release = doubleml.__version__
 
 
 # -- General configuration ---------------------------------------------------

doubleml/__init__.py

@@ -1,5 +1,3 @@
-import importlib.metadata
-
 from .data import DoubleMLClusterData, DoubleMLData, DoubleMLDIDData, DoubleMLPanelData, DoubleMLRDDData, DoubleMLSSMData
 from .did.did import DoubleMLDID
 from .did.did_cs import DoubleMLDIDCS
@@ -47,4 +45,12 @@
     "DoubleMLLPLR",
 ]
 
-__version__ = importlib.metadata.version("doubleml")
+try:
+    from ._version import version as __version__
+except ImportError:
+    import importlib.metadata
+
+    try:
+        __version__ = importlib.metadata.version("doubleml")
+    except importlib.metadata.PackageNotFoundError:
+        __version__ = "0.0.0+unknown"

doubleml/tests/test_init.py

@@ -0,0 +1,38 @@
+import importlib
+import sys
+from unittest.mock import patch
+
+import pytest
+
+
+@pytest.mark.ci
+def test_version_from_version_file():
+    """Test version is imported from _version.py when available."""
+    import doubleml
+
+    assert hasattr(doubleml, "__version__")
+    assert isinstance(doubleml.__version__, str)
+
+
+@pytest.mark.ci
+def test_version_fallback_to_metadata():
+    """Test fallback to importlib.metadata when _version.py is missing."""
+    with patch.dict(sys.modules, {"doubleml._version": None}):
+        with patch("importlib.metadata.version", return_value="1.2.3"):
+            # Re-import to trigger the fallback
+            importlib.reload(importlib.import_module("doubleml"))
+            import doubleml
+
+            assert doubleml.__version__ == "1.2.3"
+
+
+@pytest.mark.ci
+def test_version_fallback_to_unknown():
+    """Test fallback to 0.0.0+unknown when package not found."""
+    mock_error = importlib.metadata.PackageNotFoundError()
+    with patch.dict(sys.modules, {"doubleml._version": None}):
+        with patch("importlib.metadata.version", side_effect=mock_error):
+            importlib.reload(importlib.import_module("doubleml"))
+            import doubleml
+
+            assert doubleml.__version__ == "0.0.0+unknown"

pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=65", "wheel"]
+requires = ["setuptools>=80", "wheel", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "DoubleML"
-version = "0.12.dev0"
+dynamic = ["version"]
 description = "Double Machine Learning in Python"
 readme = {file = "README.md", content-type = "text/markdown"}
 license = {file = "LICENSE"}
@@ -57,6 +57,11 @@ Documentation = "https://docs.doubleml.org"
 Source = "https://github.com/DoubleML/doubleml-for-py"
 "Bug Tracker" = "https://github.com/DoubleML/doubleml-for-py/issues"
 
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "dirty-tag"
+write_to = "doubleml/_version.py"
+
 [tool.pytest.ini_options]
 markers = [
     "ci: mark a test as a continuous integration test which will be executed in github actions.",