Change to hatchling based build pipeline (#53)

* Change to hatchling based build pipeline

* use hatch-vcs

* split tests

* split tests

* split tests

* remove install current branch step

* put test-subset on a single line

* Add names

* modify matrix

* run codecov after all tests

* Use deselect to ignore specific test functions

* Only test a small subset on windows

* Adjust run_tests.yml

* more adjustments

* python 3.13 compatability change

* Don't track generated _version.py

* Don't track generated _version.py

Author: jessegrabowski

.gitattributes

@@ -16,16 +16,26 @@ jobs:
           python-version: 3.12
       - name: Install release tooling
         run: |
-          pip install twine wheel numpy setuptools versioneer
+          pip install hatch numpy
       - name: Build package
         run: |
-          python setup.py sdist bdist_wheel
+          hatch build
       - name: Check version number match
         run: |
           echo "GITHUB_REF: ${GITHUB_REF}"
           # The GITHUB_REF should be something like "refs/tags/v1.2.3"
-          # Make sure the package version is the same as the tag
-          grep -Rq "^Version: ${GITHUB_REF:11}$" gEconpy.egg-info/PKG-INFO
+          # Extract version from tag (remove 'v' prefix if present)
+          TAG_VERSION=${GITHUB_REF:11}
+          TAG_VERSION=${TAG_VERSION#v}
+          # Get the version from the built package
+          PACKAGE_VERSION=$(hatch version)
+          echo "Tag version: $TAG_VERSION"
+          echo "Package version: $PACKAGE_VERSION"
+          # Check if versions match
+          if [ "$TAG_VERSION" != "$PACKAGE_VERSION" ]; then
+            echo "Version mismatch: Tag version ($TAG_VERSION) does not match package version ($PACKAGE_VERSION)"
+            exit 1
+          fi
       - uses: actions/upload-artifact@v4
         with:
           name: bdist

.github/workflows/release.yml

@@ -15,32 +15,51 @@ concurrency:
 
 
 jobs:
-  unittest:
+  test:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
-        python-version: ["3.11", "3.12"]
-        exclude:
-          - os: ubuntu-latest
-            python-version: "3.11"
-          - os: windows-latest
+        include:
+          - subset-name: "Model Steady State Tests"
+            os: ubuntu-latest
             python-version: "3.12"
-        test-subset:
-          - |
-            tests/
-
+            test-subset: "tests/test_model.py::test_numerical_steady_state tests/test_model.py::test_steady_state tests/test_model.py::test_partially_analytical_steady_state"
+          - subset-name: "Model Tests"
+            os: ubuntu-latest
+            python-version: "3.12"
+            test-subset: "tests/test_model.py --deselect tests/test_model.py::test_numerical_steady_state --deselect tests/test_model.py::test_steady_state --deselect tests/test_model.py::test_partially_analytical_steady_state"
+          - subset-name: "Steady State Tests"
+            os: ubuntu-latest
+            python-version: "3.12"
+            test-subset: "tests/test_steady_state.py"
+          - subset-name: "Perturbation Tests"
+            os: ubuntu-latest
+            python-version: "3.12"
+            test-subset: "tests/test_perturbation.py"
+          - subset-name: "Other Tests"
+            os: ubuntu-latest
+            python-version: "3.12"
+            test-subset: "tests/ --ignore tests/test_model.py --ignore tests/test_steady_state.py --ignore tests/test_perturbation.py"
+          - subset-name: "Windows Test Model"
+            os: windows-latest
+            python-version: "3.13"
+            test-subset: "tests/test_model.py --deselect tests/test_model.py::test_numerical_steady_state --deselect tests/test_model.py::test_steady_state --deselect tests/test_model.py::test_partially_analytical_steady_state --deselect tests/test_model.py::test_all_backends_agree_on_functions --deselect tests/test_model.py::test_scipy_wrapped_functions_agree"
+          - subset-name: "Windows Other Tests"
+            os: windows-latest
+            python-version: "3.13"
+            test-subset: "tests/ --ignore tests/test_model.py --ignore tests/test_steady_state.py --ignore tests/test_perturbation.py"
+    name: ${{ matrix.subset-name }} (${{ matrix.os }} Python ${{ matrix.python-version }})
     runs-on: ${{ matrix.os }}
 
     env:
       TEST_SUBSET: ${{ matrix.test-subset }}
 
     defaults:
       run:
-        shell: bash -l {0}
+        shell: bash -leo pipefail {0}
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - uses: mamba-org/setup-micromamba@v2
       with:
@@ -53,18 +72,71 @@ jobs:
 
     - name: Install current branch
       run: |
-        conda activate geconpy-test
         pip install -e .
         python --version
 
+    - name: Create matrix id
+      id: matrix-id
+      env:
+        MATRIX_CONTEXT: ${{ toJson(matrix) }}
+      run: |
+        echo $MATRIX_CONTEXT
+        export MATRIX_ID=`echo $MATRIX_CONTEXT | sha256sum | cut -c 1-32`
+        echo $MATRIX_ID
+        echo "id=$MATRIX_ID" >> $GITHUB_OUTPUT
+
     - name: Run tests
       run: |
-        python -m pytest -vv --cache-clear --cov=gEconpy --cov-report=xml --no-cov-on-fail --cov-report term $TEST_SUBSET
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
+        python -m pytest -vv --cache-clear --cov=gEconpy --cov-report=xml:coverage/coverage-${MATRIX_ID}.xml --no-cov-on-fail --cov-report term $TEST_SUBSET
+      env:
+        MATRIX_ID: ${{ steps.matrix-id.outputs.id }}
+
+    - name: Upload coverage file
+      uses: actions/upload-artifact@v4
       with:
-        token: ${{ secrets.CODECOV_TOKEN }} # use token for more robust uploads
-        env_vars: TEST_SUBSET
-        name: ${{ matrix.os }}
-        fail_ci_if_error: false
-        verbose: true
+        name: coverage-${{ steps.matrix-id.outputs.id }}
+        path: coverage/coverage-${{ steps.matrix-id.outputs.id }}.xml
+
+
+  all-checks:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: "All tests"
+    needs: [test]
+    steps:
+      - name: Check build matrix status
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1
+
+  upload-coverage:
+    runs-on: ubuntu-latest
+    name: "Upload coverage"
+    needs: [all-checks]
+    if: ${{ needs.all-checks.result == 'success' }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U coverage>=5.1 coveralls
+
+      - name: Download coverage file
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-*
+          path: coverage
+          merge-multiple: true
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          directory: ./coverage/
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/run_tests.yml

@@ -35,6 +35,9 @@ pip-wheel-metadata/
 share/python-wheels/
 generated/
 
+# Generated by hatch-vcs, and should not be tracked.
+gEconpy/_version.py
+
 *.egg-info/
 .installed.cfg
 *.egg

.gitignore

@@ -12,7 +12,7 @@ repos:
     -   id: trailing-whitespace
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.9.10
+  rev: v0.12.4
   hooks:
     - id: ruff
       args: [ --fix, --unsafe-fixes, --exit-non-zero-on-fix ]

.pre-commit-config.yaml

@@ -9,7 +9,6 @@
     solvers,
     utilities,
 )
-from gEconpy._version import get_versions
 from gEconpy.dynare_convert import make_mod_file
 from gEconpy.model.build import model_from_gcn, statespace_from_gcn
 from gEconpy.model.model import (
@@ -26,6 +25,7 @@
 from gEconpy.model.statespace import data_from_prior
 from gEconpy.model.steady_state import print_steady_state
 from gEconpy.parser.html import print_gcn_file
+from importlib.metadata import version
 
 _log = logging.getLogger(__name__)
 
@@ -36,7 +36,7 @@
         _log.addHandler(handler)
 
 
-__version__ = get_versions()["version"]
+__version__ = version("gEconpy")
 
 __all__ = [
     "autocorrelation_matrix",