Merge pull request nsidc#473 from nsidc/v0.9.0

Updated changelog
itcarroll · Feb 29, 2024 · 8fe6097 · 8fe6097
2 parents c070ebf + e8599ff
commit 8fe6097
Show file tree

Hide file tree

Showing 10 changed files with 990 additions and 399 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -1,6 +1,7 @@
 name: Integration Tests
 
 on:
+  pull_request:
   push:
     branches:
       - main
@@ -10,6 +11,12 @@ on:
       - docs/**
       - binder/**
 
+# When this workflow is queued, automatically cancel any previous running
+# or pending jobs from the same branch
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+## [v0.9.0] 2024-02-28
+
 * Bug fixes:
     * fixed #439 by implementing more trusted domains in the SessionWithRedirection
     * fixed #438 by using an authenticated session for hits()
@@ -176,10 +178,17 @@
 - Add basic classes to interact with NASA CMR, EDL and cloud access.
 - Basic object formatting.
 
-[Unreleased]: https://github.com/nsidc/earthaccess/compare/v0.8.2...HEAD
+[Unreleased]: https://github.com/nsidc/earthaccess/compare/v0.9.0...HEAD
+[v0.8.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.2
+[v0.8.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.1
+[v0.8.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.8.0
+[v0.7.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.1
+[v0.7.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.7.0
+[v0.6.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.6.0
+[v0.5.3]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.3
 [v0.5.2]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.2
 [v0.5.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.1
-[v0.5.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.0
+[v0.5.0]: https://github.com/nsidc/earthaccess/releases/tag/v0.5.0
 [v0.4.7]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.7
 [v0.4.6]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.6
 [v0.4.1]: https://github.com/nsidc/earthaccess/releases/tag/v0.4.1

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,7 +16,7 @@ Please note we have a code of conduct, please follow it in all your interactions
 If we have `mamba` (or conda) installed, we can use the environment file included in the binder folder, this will install all the libraries we need (including Poetry) to start developing `earthaccess`
 
 ```bash
->mamba env update -f binder/environment-dev.yml
+>mamba env update -f ci/environment-dev.yml
 >mamba activate earthaccess-dev
 >poetry install
 ```

diff --git a/binder/environment-dev.yml → ci/environment-dev.yml b/binder/environment-dev.yml → ci/environment-dev.yml
diff --git a/docs/tutorials/getting-started.ipynb b/docs/tutorials/getting-started.ipynb
diff --git a/earthaccess/store.py b/earthaccess/store.py
@@ -442,7 +442,7 @@ def _open_urls(
     def get(
         self,
         granules: Union[List[DataGranule], List[str]],
-        local_path: Optional[Path] = None,
+        local_path: Union[Path, str, None] = None,
         provider: Optional[str] = None,
         threads: int = 8,
     ) -> List[str]:
@@ -468,6 +468,8 @@ def get(
             today = datetime.datetime.today().strftime("%Y-%m-%d")
             uuid = uuid4().hex[:6]
             local_path = Path.cwd() / "data" / f"{today}-{uuid}"
+        elif isinstance(local_path, str):
+            local_path = Path(local_path)
 
         if len(granules):
             files = self._get(granules, local_path, provider, threads)

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -57,7 +57,7 @@ pytest = ">=6.0"
 pytest-cov = ">=2.8"
 pytest-watch = ">=4.2"
 mkdocs = ">=1.2"
-mkdocs-material = ">=7.1"
+mkdocs-material = ">=7.1,<9.0"
 markdown-callouts = ">=0.2.0"
 markdown-include = ">=0.6"
 mkdocstrings = {extras = ["python"], version = ">=0.19.0"}

diff --git a/readthedocs.yml b/readthedocs.yml
@@ -9,18 +9,21 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.10"
   jobs:
     post_create_environment:
       # Install poetry
-      # https://python-poetry.org/docs/#installing-manually
-      - pip install poetry
+      - asdf plugin add poetry
+      - asdf install poetry latest
+      - asdf global poetry latest
       # Tell poetry to not use a virtual environment
       - poetry config virtualenvs.create false
     post_install:
       # Install dependencies with 'docs' dependency group
       # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-      - poetry install
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry env info
+      - pip freeze
 
 mkdocs:
   configuration: mkdocs.yml
diff --git a/tests/integration/conftest.py b/tests/integration/conftest.py
@@ -0,0 +1,12 @@
+import pytest
+
+ACCEPTABLE_FAILURE_RATE = 10
+
+
+@pytest.hookimpl()
+def pytest_sessionfinish(session, exitstatus):
+    if exitstatus == 0:
+        return
+    failure_rate = (100.0 * session.testsfailed) / session.testscollected
+    if failure_rate <= ACCEPTABLE_FAILURE_RATE:
+        session.exitstatus = 0