Merge pull request #316 from jrbourbeau/auth-env-util

Add utility for getting authentication environment variables

earthaccess/__init__.py

@@ -2,6 +2,7 @@
 from typing import Any
 
 from .api import (
+    auth_environ,
     collection_query,
     download,
     get_fsspec_https_session,
@@ -34,6 +35,7 @@
     "DataCollections",
     "Auth",
     "Store",
+    "auth_environ",
 ]
 
 __auth__ = Auth()

earthaccess/api.py

@@ -333,3 +333,12 @@ def get_edl_token() -> str:
     """
     token = earthaccess.__auth__.token
     return token
+
+
+def auth_environ() -> Dict[str, str]:
+    auth = earthaccess.__auth__
+    if not auth.authenticated:
+        raise RuntimeError(
+            "`auth_environ()` requires you to first authenticate with `earthaccess.login()`"
+        )
+    return {"EARTHDATA_USERNAME": auth.username, "EARTHDATA_PASSWORD": auth.password}

tests/integration/test_api.py

@@ -80,3 +80,17 @@ def test_earthaccess_api_can_download_granules(tmp_path, selection):
     files = earthaccess.download(result, str(tmp_path))
     assertions.assertIsInstance(files, list)
     assert all(os.path.exists(f) for f in files)
+
+
+def test_auth_environ():
+    environ = earthaccess.auth_environ()
+    assert environ == {
+        "EARTHDATA_USERNAME": os.environ["EARTHDATA_USERNAME"],
+        "EARTHDATA_PASSWORD": os.environ["EARTHDATA_PASSWORD"],
+    }
+
+
+def test_auth_environ_raises(monkeypatch):
+    monkeypatch.setattr(earthaccess.__auth__, "authenticated", False)
+    with pytest.raises(RuntimeError, match="authenticate"):
+        earthaccess.auth_environ()