freva-client 2404.0.0__tar.gz

freva_client-2404.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft ./assets/*
+include ./assets/share/freva/freva.conf

freva_client-2404.0.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: freva-client
+Version: 2404.0.0
+Summary: Search for climate data based on key-value pairs
+Author-email: "DKRZ, Clint" <freva@dkrz.de>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: appdirs
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: rich
+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/
+Provides-Extra: dev
+
+# A REST API for the freva databrowser
+
+[![License](https://img.shields.io/badge/License-BSD-purple.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.12-red.svg)](https://www.python.org/downloads/release/python-312/)
+[![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)
+
+The freva-client library is a small library that makes connections to the freva
+server. The client library currently supports the following services:
+
+- Freva databrowser: Search for climate and environmental datasets by sending
+`key=value` pair search requests to the freva databrowser API.
+
+## Installation
+
+Installing the freva-client library is straight forward an can be achieved via:
+
+```console
+python3 -m pip install freva-client
+```
+
+For a basic usage consult the official documentation page.
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

freva_client-2404.0.0/README.md

@@ -0,0 +1,26 @@
+# A REST API for the freva databrowser
+
+[![License](https://img.shields.io/badge/License-BSD-purple.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.12-red.svg)](https://www.python.org/downloads/release/python-312/)
+[![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)
+
+The freva-client library is a small library that makes connections to the freva
+server. The client library currently supports the following services:
+
+- Freva databrowser: Search for climate and environmental datasets by sending
+`key=value` pair search requests to the freva databrowser API.
+
+## Installation
+
+Installing the freva-client library is straight forward an can be achieved via:
+
+```console
+python3 -m pip install freva-client
+```
+
+For a basic usage consult the official documentation page.
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

freva_client-2404.0.0/assets/share/freva/freva.toml

@@ -0,0 +1,19 @@
+## The new freva configuration file.
+## This configuration files follows toml (https://toml.io) syntax and replaces
+## the old evaluation_system.conf file.
+#
+[freva]
+## This section configures the freva client. All settings related to freva
+## are set here.
+##
+## The name of the specific freva instance. If you use multiple configurations
+## for different freva instances the `project_name` entry allows you to
+## later identify which configuration you were using.
+# project_name = "freva"
+
+##
+## The host that runs the freva api system. In most cases this is just the
+## url of the freva webpage, such as https://www.freva.dkrz.de.
+## You can set a port by separating <hostname:port>
+## for example freva.example.org:7777
+# host = ""

freva_client-2404.0.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["flit_core >=3.2", "appdirs"]
+build-backend = "flit_core.buildapi"
+[project]
+name = "freva-client"
+dynamic = ["version"]
+description = "Search for climate data based on key-value pairs"
+authors = [{name = "DKRZ, Clint", email = "freva@dkrz.de"}]
+readme = "README.md"
+classifiers = [
+               "Development Status :: 3 - Alpha",
+               "Environment :: Console",
+               "Intended Audience :: Developers",
+               "Intended Audience :: Science/Research",
+               "License :: OSI Approved :: BSD License",
+               "Operating System :: POSIX :: Linux",
+               "Programming Language :: Python :: 3",
+               "Programming Language :: Python :: 3.9",
+               "Programming Language :: Python :: 3.10",
+               "Programming Language :: Python :: 3.11",
+               "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.8"
+dependencies = [
+"appdirs",
+"pyyaml",
+"requests",
+"rich",
+"tomli",
+"typer",
+]
+[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/"
+
+[project.optional-dependencies]
+dev = ["tox"]
+
+[tool.flit.sdist]
+include = ["assets/*"]
+
+[tool.flit.external-data]
+directory = "assets"
+[package-data]
+freva_deployment = ["py.typed"]

freva_client-2404.0.0/src/freva_client/__init__.py

@@ -0,0 +1,20 @@
+"""Client software freva evaluation system framework (freva):
+
+Freva, the free evaluation system framework, is a data search and analysis
+platform developed by the atmospheric science community for the atmospheric
+science community. With help of Freva researchers can:
+
+- quickly and intuitively search for data stored at typical data centers that
+  host many datasets.
+- create a common interface for user defined data analysis tools.
+- apply data analysis tools in a reproducible manner.
+
+The code described here is currently in testing phase. The client and server
+library described in the documentation only support searching for data. If you
+need to apply data analysis plugins, please visit the
+"""
+
+from .query import databrowser
+
+__version__ = "2404.0.0"
+__all__ = ["databrowser", "__version__"]

freva_client-2404.0.0/src/freva_client/__main__.py

@@ -0,0 +1,10 @@
+"""Freva command line interface."""
+
+import sys
+
+from freva_client import cli
+
+__all__ = ["cli"]
+
+if __name__ == "__main__":
+    sys.exit(cli.app())

freva_client-2404.0.0/src/freva_client/cli/__init__.py

@@ -0,0 +1,6 @@
+"""Command line interface for the freva-client library."""
+
+from .cli_app import app
+from .databrowser_cli import *  # noqa: F401
+
+__all__ = ["app"]

freva_client-2404.0.0/src/freva_client/cli/cli_app.py

@@ -0,0 +1,22 @@
+"""Freva the Free Evaluation System command line interface."""
+
+import typer
+from freva_client import __version__
+from freva_client.utils import logger
+from rich import print as pprint
+
+APP_NAME: str = "freva-client"
+
+app = typer.Typer(
+    name=APP_NAME,
+    help=__doc__,
+    add_completion=False,
+    callback=logger.set_cli,
+)
+
+
+def version_callback(version: bool) -> None:
+    """Print the version and exit."""
+    if version:
+        pprint(f"{APP_NAME}: {__version__}")
+        raise typer.Exit()

freva_client-2404.0.0/src/freva_client/cli/cli_utils.py

@@ -0,0 +1,165 @@
+"""Utilities for the command line interface."""
+
+import argparse
+import inspect
+from typing import Any, Callable, Dict, List, Optional, Tuple, cast
+
+from freva_client import databrowser
+from freva_client.cli.cli_app import app
+from freva_client.utils import logger
+
+
+def parse_cli_args(cli_args: List[str]) -> Dict[str, List[str]]:
+    """Convert the cli arguments to a dictionary."""
+    logger.debug("parsing command line arguments.")
+    kwargs = {}
+    for entry in cli_args:
+        key, _, value = entry.partition("=")
+        if value and key not in kwargs:
+            kwargs[key] = [value]
+        elif value:
+            kwargs[key].append(value)
+    logger.debug(kwargs)
+    return kwargs
+
+
+class Completer:
+    """Base class for command line argument completers."""
+
+    def __init__(
+        self,
+        argv: List[str],
+        choices: Optional[Dict[str, Tuple[str, str]]] = None,
+        shell: str = "bash",
+        strip: bool = False,
+        flags_only: bool = False,
+    ):
+        self.choices = choices or {}
+        self.strip = strip
+        self.argv = argv
+        self.flags_only = flags_only
+        if shell == "zsh":
+            self.get_print = self._print_zsh
+        elif shell == "fish":
+            self.get_print = self._print_fish
+        else:
+            self.get_print = self._print_default
+
+    def _print_zsh(self, choices: Dict[str, Tuple[str, str]]) -> List[str]:
+        out = []
+        for key, _help in choices.items():
+            if key.startswith("-"):
+                out.append(f"{key}[{_help}]")
+            else:
+                out.append(f"{key}: {_help}")
+        return out
+
+    def _print_fish(self, choices: Dict[str, Tuple[str, str]]) -> List[str]:
+        out = []
+        for key, _help in choices.items():
+            out.append(f"{key}: {_help}")
+        return out
+
+    def _print_default(self, choices: Dict[str, Tuple[str, str]]) -> List[str]:
+        out = []
+        for key, _help in choices.items():
+            if not key.startswith("-"):
+                out.append(f"{key}: {_help}")
+            else:
+                out.append(key)
+        return out
+
+    def _get_choices(self) -> Dict[str, Tuple[str, str]]:
+        """Get the choices for databrowser command."""
+
+        facet_args = []
+        for arg in self.argv:
+            if len(arg.split("=")) == 2:
+                facet_args.append(arg)
+        search_keys = parse_cli_args(facet_args)
+        search = databrowser.metadata_search(
+            flavour="freva",
+            time=None,
+            host=None,
+            time_select="flexible",
+            multiversion=False,
+            extended_search=True,
+            fail_on_error=False,
+            **search_keys,
+        )
+        choices = {}
+        for att, values in search.items():
+            if att not in search_keys:
+                keys = ",".join([v for n, v in enumerate(values)])
+                choices[att] = (keys, "")
+        return choices
+
+    @property
+    def command_choices(self) -> Dict[str, Tuple[str, str]]:
+        """Get the command line arguments for all sub commands."""
+
+        if self.flags_only:
+            return self.choices
+        choices = self._get_choices()
+        return {**self.choices, **choices}
+
+    def formated_print(self) -> None:
+        """Print all choices to be processed by the shell completion function."""
+
+        out = self.get_print(self.command_choices)
+        for line in out:
+            if line.startswith("-") and self.strip and not self.flags_only:
+                continue
+            if not line.startswith("-") and self.flags_only:
+                continue
+            print(line)
+
+    @classmethod
+    def parse_choices(cls, argv: list[str]) -> "Completer":
+        """Create the completion choices from given cmd arguments."""
+        parser = argparse.ArgumentParser(
+            description="Get choices for command line arguments"
+        )
+        parser.add_argument(
+            "--strip",
+            help="Do not print options starting with -",
+            default=False,
+            action="store_true",
+        )
+        parser.add_argument(
+            "--shell",
+            help="Set the target shell type.",
+            default=False,
+        )
+        parser.add_argument(
+            "--flags-only",
+            help="Only print options starting with -",
+            default=False,
+            action="store_true",
+        )
+        cli_app, args = parser.parse_known_args(argv)
+        main_choices = {c.name: (c, c.help) for c in app.registered_commands}
+        choices = {}
+        if args and args[0] == "freva-databrowser":
+            _ = args.pop(0)
+        if args[0] in main_choices:
+            signature = inspect.signature(
+                cast(Callable[..., Any], main_choices[args[0]][0].callback)
+            )
+            for param, value in signature.parameters.items():
+                if param in args or param == "search_keys":
+                    continue
+                if hasattr(value.annotation, "__metadata__"):
+                    option = value.annotation.__metadata__
+                else:
+                    option = value.default
+                choices[option.param_decls[-1]] = option.help
+        else:
+            choices = {k: v[1] for k, v in main_choices.items()}
+        return cls(
+            args,
+            choices,
+            shell=cli_app.shell,
+            strip=cli_app.strip,
+            flags_only=cli_app.flags_only,
+        )