Transition from setuptools to hatchling (#410)

* Transition from setuptools to hatchling

* Format black

---------

Co-authored-by: pyiron-runner <[email protected]>

Author: jan-janssen

.ci_support/environment-docs.yml

@@ -13,4 +13,5 @@ dependencies:
 - tqdm =4.67.1
 - jupyter-book =1.0.0
 - python =3.12
-- setuptools =80.8.0
+- hatchling =1.27.0
+- hatch-vcs =0.4.0

.ci_support/environment-old.yml

@@ -7,4 +7,5 @@ dependencies:
 - jinja2 =2.11.3
 - paramiko =2.7.1
 - tqdm =4.66.1
-- setuptools =75.1.0
+- hatchling =1.27.0
+- hatch-vcs =0.4.0

.ci_support/environment.yml

@@ -8,4 +8,5 @@ dependencies:
 - jinja2 =3.1.6
 - paramiko =3.5.1
 - tqdm =4.67.1
-- setuptools =80.8.0
+- hatchling =1.27.0
+- hatch-vcs =0.4.0

.github/workflows/deploy.yml

@@ -31,10 +31,9 @@ jobs:
       run: |
         cp .ci_support/environment-old.yml environment.yml
         python .ci_support/release.py; cat pyproject.toml
+        git update-index --assume-unchanged pyproject.toml pysqa/_version.py
     - name: Build
       shell: bash -l {0}
-      run: |
-        pip install versioneer[toml]==0.29
-        python setup.py sdist bdist_wheel
+      run: hatchling build -t sdist -t wheel
     - name: Publish distribution 📦 to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pipeline.yml

@@ -60,9 +60,7 @@ jobs:
           environment-file: environment.yml
       - name: Install
         shell: bash -l {0}
-        run: |
-          pip install versioneer[toml]==0.29
-          pip install . --no-deps --no-build-isolation
+        run: pip install . --no-deps --no-build-isolation
       - name: Test
         shell: bash -l {0}
         run: >
@@ -98,7 +96,6 @@ jobs:
       - name: Test
         shell: bash -l {0}
         run: |
-          pip install versioneer[toml]==0.29
           pip install . --no-deps --no-build-isolation
           python -m unittest discover tests
 
@@ -122,7 +119,6 @@ jobs:
       - name: Install
         shell: bash -l {0}
         run: |
-          pip install versioneer[toml]==0.29
           pip install . --no-deps --no-build-isolation
           mkdir config
           cp -r tests/config/flux config
@@ -154,7 +150,7 @@ jobs:
       - name: Pip check
         shell: bash -l {0}
         run: |
-          pip install versioneer[toml]==0.29 tomlkit
+          pip install tomlkit
           python .ci_support/check.py
           cat pyproject.toml
           pip install . --no-deps --no-build-isolation
@@ -202,7 +198,6 @@ jobs:
       - name: Test
         shell: bash -l {0}
         run: |
-          pip install versioneer[toml]==0.29
           pip install . --no-deps --no-build-isolation
           python -m unittest discover tests
 
@@ -223,7 +218,6 @@ jobs:
       - name: Test
         shell: bash -l {0}
         run: |
-          pip install versioneer[toml]==0.29
           pip install . --no-deps --no-build-isolation
           python -m unittest discover tests
 

.readthedocs.yml

@@ -12,7 +12,6 @@ build:
   jobs:
     pre_build:
       # Generate the Sphinx configuration for this Jupyter Book so it builds.
-      - pip install versioneer[toml]==0.29
       - pip install . --no-deps --no-build-isolation
       - "cp README.md docs"
       - "cp notebooks/*.ipynb docs"

binder/environment.yml

@@ -11,5 +11,5 @@ dependencies:
 - executorlib =0.0.2
 - cloudpickle =3.0.0
 - flux-core =0.59.0
-- versioneer =0.28
-- setuptools =80.8.0
+- hatchling =1.27.0
+- hatch-vcs =0.4.0

pyproject.toml

@@ -3,10 +3,10 @@ requires = [
     "jinja2==3.1.6", 
     "pandas==2.2.3", 
     "pyyaml==6.0.2", 
-    "setuptools==80.8.0",
-    "versioneer[toml]==0.29",
+    "hatchling==1.27.0",
+    "hatch-vcs==0.4.0",
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "hatchling.build"
 
 [project]
 name = "pysqa"
@@ -53,12 +53,6 @@ twofactor = ["pyauthenticator==0.2.0"]
 [project.scripts]
 pysqa = "pysqa.cmd:command_line"
 
-[tool.setuptools.packages.find]
-include = ["pysqa*"]
-
-[tool.setuptools.dynamic]
-version = {attr = "pysqa.__version__"}
-
 [tool.ruff]
 exclude = [".ci_support", "docs", "notebooks", "tests", "setup.py", "_version.py"]
 
@@ -96,9 +90,24 @@ ignore = [
     "PLR0915",
 ]
 
-[tool.versioneer]
-VCS = "git"
-style = "pep440-pre"
-versionfile_source = "pysqa/_version.py"
-parentdir_prefix = "pysqa"
-tag_prefix = "pysqa-"
+[tool.hatch.build]
+include = [
+    "pysqa"
+]
+
+[tool.hatch.build.hooks.vcs]
+version-file = "pysqa/_version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "pysqa"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "pysqa"
+]
+
+[tool.hatch.version]
+source = "vcs"
+path = "pysqa/_version.py"

pysqa/__init__.py

@@ -1,6 +1,6 @@
 from pysqa.queueadapter import QueueAdapter
 
-from ._version import get_versions
+from . import _version
 
 __all__ = ["QueueAdapter"]
-__version__ = get_versions()["version"]
+__version__ = _version.__version__