Merge pull request #733 from nsidc/poetry-groups-to-pep621-optional-deps

Replace `poetry` with `pip`, build with `hatchling`, dynamically calculate minimum dependencies with `uv`
nsidc · Sep 17, 2024 · 028b8fa · 028b8fa
2 parents 699cc4e + de313be
commit 028b8fa
Show file tree

Hide file tree

Showing 25 changed files with 4,556 additions and 5,646 deletions.
diff --git a/.github/actions/install-pkg/action.yml b/.github/actions/install-pkg/action.yml
@@ -0,0 +1,23 @@
+name: Install earthaccess Python package
+description: Install earthaccess Python package and testing dependencies
+
+inputs:
+  python-version:
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: pip
+
+    - name: Display full python version
+      shell: bash
+      id: full-python-version
+      run: echo "{version}=$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")" >> $GITHUB_OUTPUT
+
+    - name: Install package and test dependencies
+      shell: bash
+      run: pip install .[test]
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -17,10 +17,6 @@ concurrency:
   group: integration-tests-${{ github.ref }}
   cancel-in-progress: true
 
-defaults:
-  run:
-    shell: bash -l {0}
-
 jobs:
   integration-tests:
     runs-on: ubuntu-latest
@@ -31,44 +27,19 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
+
+      - uses: ./.github/actions/install-pkg
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Get full python version
-        id: full-python-version
-        run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
-      - name: Install poetry
-        uses: abatilo/actions-poetry@v3
-      - name: Configure poetry
-        run: |
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
-          poetry self add setuptools
-      - name: Set up cache
-        uses: actions/cache@v4
-        id: cache
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('poetry.lock') }}
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - name: Install Dependencies
-        if: ${{ !env.ACT }}
-        run: poetry install
-      - name: Install Dependencies
-        if: ${{ env.ACT }}
-        # When using `act` to run the workflow locally, the `poetry install` command
-        # may fail due to network issues when running multiple Docker containers.
-        run: poetry install || poetry install || poetry install
+
       - name: Test
         env:
           EARTHDATA_USERNAME: ${{ secrets.EDL_USERNAME }}
           EARTHDATA_PASSWORD: ${{ secrets.EDL_PASSWORD }}
           EARTHACCESS_TEST_USERNAME: ${{ secrets.EDL_USERNAME }}
           EARTHACCESS_TEST_PASSWORD: ${{ secrets.EDL_PASSWORD }}
-        run: poetry run bash scripts/integration-test.sh
+        run: ./scripts/integration-test.sh
+
       - name: Upload coverage
         # Don't upload coverage when using the `act` tool to run the workflow locally
         if: ${{ !env.ACT }}

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -5,13 +5,32 @@ on:
 
 jobs:
   build:
+    name: Build package
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
       - name: verify version matches git tag
         run: scripts/verify_tag.sh
-      - name: Build and publish to pypi
-        uses: JRubics/[email protected]
+
+      - uses: hynek/build-and-inspect-python-package@v2
+
+  publish:
+    name: Publish to PyPI
+    needs: ["build"]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        # NOTE: This is not the current best practice. Instead, we should use
+        # "trusted publishing":
+        # https://github.com/pypa/gh-action-pypi-publish?tab=readme-ov-file#trusted-publishing
         with:
-          python_version: "3.9"
-          pypi_token: ${{ secrets.PYPI_TOKEN }}
+          password: ${{ secrets.PYPI_TOKEN }}
diff --git a/.github/workflows/test-mindeps.yml b/.github/workflows/test-mindeps.yml
@@ -1,4 +1,4 @@
-name: Test minimum dependencies
+name: Unit test minimum dependencies
 
 on:
   push:
@@ -11,11 +11,6 @@ concurrency:
   group: test-mindeps-${{ github.ref }}
   cancel-in-progress: true
 
-# Required shell entrypoint to have properly activated conda environments
-defaults:
-  run:
-    shell: bash -l {0}
-
 jobs:
   test-mindeps:
     runs-on: ubuntu-latest
@@ -25,25 +20,26 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/[email protected]
-      - name: Setup Conda Environment
-        uses: conda-incubator/[email protected]
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          version: "0.4.7"
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          miniforge-variant: Mambaforge
-          miniforge-version: latest
-          use-mamba: true
-          channel-priority: strict
-          environment-file: ci/environment-mindeps.yaml
-          activate-environment: test-environment
-          auto-activate-base: false
+          python-version-file: pyproject.toml
 
-      - name: Install
-        run: python -m pip install --no-deps -e .
+      - name: Install minimum-compatible dependencies
+        run: uv sync --resolution lowest-direct --extra test
 
-      - name: mamba list
-        run: mamba list
+      - name: Install earthaccess
+        run: uv pip install --no-deps .
 
       - name: Test
-        run: bash scripts/test.sh
+        run: uv run pytest tests/unit --cov=earthaccess --cov=tests --cov-report=term-missing --capture=no --tb=native --log-cli-level=INFO
 
       - name: Upload coverage
         # Don't upload coverage when using the `act` tool to run the workflow locally

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,13 +2,11 @@ name: Unit Tests
 
 on:
   push:
+    branches:
+      - main
   pull_request:
     types: [opened, synchronize]
 
-defaults:
-  run:
-    shell: bash -l {0}
-
 jobs:
   unit-tests:
     runs-on: ubuntu-latest
@@ -19,45 +17,17 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
+
+      - uses: ./.github/actions/install-pkg
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Get full python version
-        id: full-python-version
-        run: echo "version=$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")" >> $GITHUB_OUTPUT
-      - name: Install poetry
-        uses: abatilo/actions-poetry@v3
-      - name: Configure poetry
-        run: |
-          poetry config virtualenvs.create true --local
-          poetry config virtualenvs.in-project true --local
-          poetry self add setuptools
-      - name: Set up mypy cache
-        uses: actions/cache@v4
-        id: mypy-cache
-        with:
-          path: .mypy_cache
-          key: mypy-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('poetry.lock') }}
-      - name: Set up cache
-        uses: actions/cache@v4
-        id: cache
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('poetry.lock') }}
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv
-      - name: Install Dependencies
-        if: ${{ !env.ACT }}
-        run: poetry install --quiet
-      - name: Install Dependencies
-        if: ${{ env.ACT }}
-        # When using `act` to run the workflow locally, the `poetry install` command
-        # may fail due to network issues when running multiple Docker containers.
-        run: poetry install --quiet || poetry install --quiet || poetry install --quiet
+
+      - name: Typecheck
+        run: mypy
+
       - name: Test
-        run: poetry run bash scripts/test.sh
+        run: pytest tests/unit --cov=earthaccess --cov=tests --cov-report=term-missing --capture=no --tb=native --log-cli-level=INFO
+
       - name: Upload coverage
         # Don't upload coverage when using the `act` tool to run the workflow locally
         if: ${{ !env.ACT }}

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,6 +33,12 @@ repos:
       - id: ruff
         args: ["--fix", "--exit-non-zero-on-fix"]
       - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: "0.4.7"
+    hooks:
+      - id: uv-lock
+
   - repo: https://github.com/google/yamlfmt
     rev: v0.13.0
     hooks:

diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -82,7 +82,7 @@ Visit [our quick start guide](https://earthaccess.readthedocs.io/en/latest/quick
 
 ## Compatibility
 
-Only **Python 3.8+** is supported.
+The _minimum_ supported Python version is **3.9**.
 
 
 ## How to Contribute to `earthaccess`

diff --git a/binder/environment.yml b/binder/environment.yml
@@ -18,3 +18,7 @@ dependencies:
   - hvplot
   - holoviews
   - panel
+
+  - pip
+  - pip:
+      - "."
diff --git a/binder/postBuild b/binder/postBuild
diff --git a/ci/environment-dev.yml b/ci/environment-dev.yml
diff --git a/ci/environment-mindeps.yaml b/ci/environment-mindeps.yaml
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,3 +18,7 @@ dependencies: @@
       - hvplot
       - holoviews
       - panel
+      - pip
+      - pip:
+          - "."