Merge pull request #120 from templateflow/maint/hatchling

MAINT: Migrate to hatchling packaging

Author: oesteban

.circleci/config.yml

@@ -31,7 +31,7 @@ jobs:
             pip install -U pip
             pip install -r /tmp/src/templateflow/requirements.txt
             pip install datalad
-            pip install "setuptools>=45" "setuptools_scm >= 6.2" nipreps-versions build twine codecov
+            pip install -U build hatch hatchling nipreps-versions build twine codecov
 
       - run:
           name: Install git and git-annex
@@ -173,8 +173,8 @@ jobs:
           name: Build only this commit
           command: |
             export PATH="$HOME/.conda/bin:$PATH"
-            python -m pip install "setuptools_scm>=8"
-            python -m setuptools_scm
+            python -m pip install -U build hatch hatchling
+            python -m hatch version
             make -C docs SPHINXOPTS="-W" BUILDDIR="$HOME/html" CURBRANCH="${CIRCLE_TAG}" html
       - store_artifacts:
           path: ~/html

.git_archival.txt

@@ -1 +1,4 @@
-ref-names: $Format:%D$
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.github/workflows/pythonpackage.yml

@@ -49,11 +49,11 @@ jobs:
         run: |
           python -m venv /tmp/buildenv
           source /tmp/buildenv/bin/activate
-          python -m pip install --upgrade setuptools setuptools_scm nipreps-versions
+          python -m pip install -U build hatch hatchling nipreps-versions
           if [[ "$GITHUB_REF" == refs/tags/* ]]; then
             TAG=${GITHUB_REF##*/}
           fi
-          THISVERSION=$( python -m setuptools_scm )
+          THISVERSION=$( python -m hatch version | tail -n1 | xargs )
           THISVERSION=${TAG:-$THISVERSION}
           echo "Expected VERSION: \"${THISVERSION}\""
           echo "version=${THISVERSION}" >> $GITHUB_OUTPUT

.gitignore

@@ -1,5 +1,5 @@
-# setuptools_scm
-templateflow/_version.py
+# hatchling
+_version.py
 
 # circleci hash checking
 requirements.txt

docs/environment.yml

@@ -151,7 +151,6 @@ dependencies:
   - readline=8.1=h46c0cb4_0
   - requests=2.27.1=pyhd8ed1ab_0
   - scipy=1.8.0=py39hee8e79c_1
-  - setuptools=62.1.0=py39hf3d152e_0
   - six=1.16.0=pyh6c4a22f_0
   - snowballstemmer=2.2.0=pyhd8ed1ab_0
   - soupsieve=2.3.1=pyhd8ed1ab_0
@@ -203,5 +202,7 @@ dependencies:
     - nipreps-versions==1.0.3
     - pandas==1.4.2
     - pybids==0.15.2
-    - setuptools_scm==7.1.0
     - sqlalchemy==1.3.24
+    - hatchling
+    - hatch-vcs
+    - nipreps-versions

pyproject.toml

@@ -1,18 +1,6 @@
 [build-system]
-requires = [
-    "setuptools>=64",
-    "setuptools_scm>=8",
-]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools_scm]
-version_file = "templateflow/_version.py"
-version_file_template = """\
-\"\"\"Version file, automatically generated by setuptools_scm.\"\"\"
-__version__ = "{version}"
-"""
-fallback_version = "0.0"
-# version_scheme = "nipreps-calver"
+requires = ["hatchling", "hatch-vcs", "nipreps-versions"]
+build-backend = "hatchling.build"
 
 [project]
 name = "templateflow"
@@ -73,6 +61,32 @@ tests = ["templateflow[test]"]
 docs = ["templateflow[doc]"]
 all = ["templateflow[datalad,doc,test]"]
 
+#
+# Hatch configurations
+#
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.sdist]
+exclude = [".git_archival.txt"]  # No longer needed in sdist
+
+[tool.hatch.build.targets.wheel]
+packages = ["templateflow"]
+# exclude = [
+#     "templateflow/tests/data",  # Large test data directory
+# ]
+
+##  The following two sections configure setuptools_scm in the hatch way
+
+[tool.hatch.version]
+validate-bump = true
+source = "vcs"
+raw-options = { version_scheme = "nipreps-calver" }
+
+[tool.hatch.build.hooks.vcs]
+version-file = "templateflow/_version.py"
+
 #
 # Developer tool configurations
 #

templateflow/tests/test_version.py

@@ -7,7 +7,7 @@
 
 
 def test_version_scm0(monkeypatch):
-    """Retrieve the version via setuptools_scm."""
+    """Retrieve the version."""
 
     class _version:
         __version__ = '10.0.0'