freva-client 2506.0.1__tar.gz → 2507.0.0__tar.gz

{freva_client-2506.0.1 → freva_client-2507.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: freva-client
-Version: 2506.0.1
+Version: 2507.0.0
 Summary: Search for climate data based on key-value pairs
 Author-email: "DKRZ, Clint" <freva@dkrz.de>
 Requires-Python: >=3.8
@@ -26,18 +26,18 @@ Requires-Dist: setuptools
 Requires-Dist: tomli
 Requires-Dist: typer
 Requires-Dist: tox ; extra == "dev"
-Project-URL: Documentation, https://freva-clint.github.io/freva-nextgen
-Project-URL: Issues, https://github.com/FREVA-CLINT/freva-nextgen/issues
-Project-URL: Source, https://github.com/FREVA-CLINT/freva-nextgen/
+Project-URL: Documentation, https://freva-org.github.io/freva-nextgen
+Project-URL: Issues, https://github.com/freva-org/freva-nextgen/issues
+Project-URL: Source, https://github.com/freva-org/freva-nextgen/
 Provides-Extra: dev
 
 # A REST API for the freva databrowser
 
 [![License](https://img.shields.io/badge/License-BSD-purple.svg)](LICENSE)
 [![PyPI](https://img.shields.io/pypi/pyversions/freva-client.svg)](https://pypi.org/project/freva-client/)
-[![Docs](https://img.shields.io/badge/API-Doc-green.svg)](https://freva-clint.github.io/freva-nextgen)
-[![Tests](https://github.com/FREVA-CLINT/freva-nextgen/actions/workflows/ci_job.yml/badge.svg)](https://github.com/FREVA-CLINT/freva-nextgen/actions)
-[![Test-Coverage](https://codecov.io/github/FREVA-CLINT/freva-nextgen/branch/init/graph/badge.svg?token=dGhXxh7uP3)](https://codecov.io/github/FREVA-CLINT/freva-nextgen)
+[![Docs](https://img.shields.io/badge/API-Doc-green.svg)](https://freva-org.github.io/freva-nextgen)
+[![Tests](https://github.com/freva-org/freva-nextgen/actions/workflows/ci_job.yml/badge.svg)](https://github.com/freva-org/freva-nextgen/actions)
+[![Test-Coverage](https://codecov.io/github/freva-org/freva-nextgen/branch/init/graph/badge.svg?token=dGhXxh7uP3)](https://codecov.io/github/freva-org/freva-nextgen)
 
 The freva-client library is a small library that makes connections to the freva
 server. The client library currently supports the following services:

{freva_client-2506.0.1 → freva_client-2507.0.0}/README.md

@@ -2,9 +2,9 @@
 
 [![License](https://img.shields.io/badge/License-BSD-purple.svg)](LICENSE)
 [![PyPI](https://img.shields.io/pypi/pyversions/freva-client.svg)](https://pypi.org/project/freva-client/)
-[![Docs](https://img.shields.io/badge/API-Doc-green.svg)](https://freva-clint.github.io/freva-nextgen)
-[![Tests](https://github.com/FREVA-CLINT/freva-nextgen/actions/workflows/ci_job.yml/badge.svg)](https://github.com/FREVA-CLINT/freva-nextgen/actions)
-[![Test-Coverage](https://codecov.io/github/FREVA-CLINT/freva-nextgen/branch/init/graph/badge.svg?token=dGhXxh7uP3)](https://codecov.io/github/FREVA-CLINT/freva-nextgen)
+[![Docs](https://img.shields.io/badge/API-Doc-green.svg)](https://freva-org.github.io/freva-nextgen)
+[![Tests](https://github.com/freva-org/freva-nextgen/actions/workflows/ci_job.yml/badge.svg)](https://github.com/freva-org/freva-nextgen/actions)
+[![Test-Coverage](https://codecov.io/github/freva-org/freva-nextgen/branch/init/graph/badge.svg?token=dGhXxh7uP3)](https://codecov.io/github/freva-org/freva-nextgen)
 
 The freva-client library is a small library that makes connections to the freva
 server. The client library currently supports the following services:

{freva_client-2506.0.1 → freva_client-2507.0.0}/pyproject.toml

@@ -35,9 +35,9 @@ dependencies = [
 [project.scripts]
 freva-client = "freva_client:cli.app"
 [project.urls]
-Documentation = "https://freva-clint.github.io/freva-nextgen"
-Issues = "https://github.com/FREVA-CLINT/freva-nextgen/issues"
-Source = "https://github.com/FREVA-CLINT/freva-nextgen/"
+Documentation = "https://freva-org.github.io/freva-nextgen"
+Issues = "https://github.com/freva-org/freva-nextgen/issues"
+Source = "https://github.com/freva-org/freva-nextgen/"
 
 [project.optional-dependencies]
 dev = ["tox"]

{freva_client-2506.0.1 → freva_client-2507.0.0}/src/freva_client/__init__.py

@@ -17,5 +17,5 @@ need to apply data analysis plugins, please visit the
 from .auth import authenticate
 from .query import databrowser
 
-__version__ = "2506.0.1"
+__version__ = "2507.0.0"
 __all__ = ["authenticate", "databrowser", "__version__"]

{freva_client-2506.0.1 → freva_client-2507.0.0}/src/freva_client/auth.py

@@ -243,17 +243,16 @@ class Auth:
         config: Optional[Config] = None,
         *,
         force: bool = False,
-        _auto: bool = True,
         _cli: bool = False,
     ) -> Token:
         """Authenticate the user to the host."""
         cfg = config or Config(host)
         token = self._auth_token or load_token(self.token_file)
         reason: Optional[str] = None
-        if _auto:
-            strategy = choose_token_strategy(token)
-        else:
+        if force:
             strategy = "browser_auth"
+        else:
+            strategy = choose_token_strategy(token)
         if strategy == "use_token" and token:
             self._auth_token = token
             return self._auth_token
@@ -261,8 +260,6 @@ class Auth:
             if strategy == "refresh_token" and token:
                 return self._refresh(cfg.auth_url, token["refresh_token"])
             if strategy == "browser_auth":
-                if _auto:
-                    logger.warning("Automatically launching browser-based login")
                 return self._login(cfg.auth_url, force=force)
         except AuthError as error:
             reason = str(error)
@@ -330,5 +327,4 @@ def authenticate(
     return auth.authenticate(
         host=host,
         force=force,
-        _auto=False,
     )

{freva_client-2506.0.1 → freva_client-2507.0.0}/src/freva_client/cli/auth_cli.py

@@ -59,6 +59,5 @@ def authenticate_cli(
         host=host,
         force=force,
         _cli=True,
-        _auto=False,
     )
     print(json.dumps(token, indent=3))

{freva_client-2506.0.1 → freva_client-2507.0.0}/src/freva_client/cli/databrowser_cli.py

@@ -289,7 +289,7 @@ def data_search(
     token_file: Optional[Path] = typer.Option(
         None,
         "--token-file",
-        "-t",
+        "-tf",
         help=(
             "Instead of authenticating via code based authentication flow "
             "you can set the path to the json file that contains a "
@@ -468,6 +468,7 @@ def intake_catalogue(
     token_file: Optional[Path] = typer.Option(
         None,
         "--token-file",
+        "-tf",
         help=(
             "Instead of authenticating via code based authentication flow "
             "you can set the path to the json file that contains a "
@@ -861,6 +862,7 @@ def user_data_add(
     token_file: Optional[Path] = typer.Option(
         None,
         "--token-file",
+        "-tf",
         help=(
             "Instead of authenticating via code based authentication flow "
             "you can set the path to the json file that contains a "
@@ -917,6 +919,7 @@ def user_data_delete(
     token_file: Optional[Path] = typer.Option(
         None,
         "--token-file",
+        "-tf",
         help=(
             "Instead of authenticating via code based authentication flow "
             "you can set the path to the json file that contains a "

{freva_client-2506.0.1 → freva_client-2507.0.0}/src/freva_client/query.py

@@ -28,6 +28,7 @@ from rich import print as pprint
 
 from .auth import Auth
 from .utils import logger
+from .utils.auth_utils import Token, choose_token_strategy, load_token
 from .utils.databrowser_utils import Config, UserDataHandler
 
 __all__ = ["databrowser"]
@@ -205,6 +206,8 @@ class databrowser:
 
     .. code-block:: python
 
+        from freva_client import authenticate
+        token_info = authenticate()
         import xarray as xr
         dset = xr.open_dataset(
            zarr_files[0],
@@ -385,6 +388,41 @@ class databrowser:
                 f"Couldn't write catalogue content: {error}"
             ) from None
 
+    @property
+    def auth_token(self) -> Optional[Token]:
+        """Get the current OAuth2 token - if it is still valid.
+
+        Returns
+        -------
+        Token:
+            If the OAuth2 token exists,is valid and can be used it will
+            be returned, None otherwise.
+
+        Example
+        -------
+
+        .. code-block:: python
+
+            from freva_client import databrowser
+            import xarray as xr
+            db = databrowser(dataset="cmip6-hsm", stream_zarr=True)
+            dset = xr.open_dataset(
+               zarr_files[0],
+               chunks="auto",
+               engine="zarr",
+               storage_options={"headers":
+                    {"Authorization": f"Bearer {db.auth_token['access_token']}"}
+               }
+            )
+        """
+        token = self._auth._auth_token or load_token(self._auth.token_file)
+        strategy = choose_token_strategy(token)
+        if strategy in ("browser_auth", "fail"):
+            return None
+        if strategy == "refresh_token":
+            token = self._auth.authenticate(config=self._cfg)
+        return token
+
     def intake_catalogue(self) -> intake_esm.core.esm_datastore:
         """Create an intake esm catalogue object from the search.