ecmwf-datastores-client 0.1.0__tar.gz → 0.3.0__tar.gz

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/ecmwf-projects/cookiecutter-conda-package",
-  "commit": "18065cb3d40660d1b7d74ac1cbe285f08552e658",
+  "commit": "0b4d61da26c3aacfc1778716cb36749d16846c51",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -13,7 +13,7 @@
       "integration_tests": "True",
       "pypi": true,
       "_template": "https://github.com/ecmwf-projects/cookiecutter-conda-package",
-      "_commit": "18065cb3d40660d1b7d74ac1cbe285f08552e658"
+      "_commit": "0b4d61da26c3aacfc1778716cb36749d16846c51"
     }
   },
   "directory": null

ecmwf_datastores_client-0.3.0/.github/workflows/on-pr-closed.yml

@@ -0,0 +1,18 @@
+name: on-pr-closed
+on:
+  pull_request:
+    types:
+    - closed
+
+jobs:
+  remove-preview:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: rossjrw/pr-preview-action@v1
+      with:
+        action: "remove"

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/.github/workflows/on-push.yml

@@ -117,6 +117,7 @@ jobs:
     runs-on: macos-latest
     permissions:
       contents: write
+      pull-requests: write
 
     steps:
     - uses: actions/checkout@v4
@@ -140,16 +141,26 @@ jobs:
       run: |
         python -m pip install --no-deps -e .
     - name: Build documentation
+      timeout-minutes: 10
+      env:
+        ECMWF_DATASTORES_URL: ${{ secrets.ECMWF_DATASTORES_URL }}
+        ECMWF_DATASTORES_KEY: ${{ secrets.ECMWF_DATASTORES_KEY }}
+        ANONYMOUS_PAT: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
       run: |
         make docs-build
+    - uses: rossjrw/pr-preview-action@v1
+      with:
+        source-dir: "docs/_build/html"
     - name: Deploy documentation
-      uses: peaceiris/actions-gh-pages@v4
+      uses: JamesIves/github-pages-deploy-action@v4
       if: |
         github.event_name == 'push' &&
         startsWith(github.ref, 'refs/tags')
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs/_build/html/
+        folder: ./docs/_build/html/
+        # See: https://github.com/marketplace/actions/deploy-pr-preview#ensure-your-main-deployment-is-compatible
+        clean-exclude: pr-preview/
+        force: false
 
   integration-tests:
     needs: [combine-environments, unit-tests]
@@ -188,7 +199,7 @@ jobs:
       env:
         ECMWF_DATASTORES_URL: ${{ secrets.ECMWF_DATASTORES_URL }}
         ECMWF_DATASTORES_KEY: ${{ secrets.ECMWF_DATASTORES_KEY }}
-        ECMWF_DATASTORES_ANON_KEY: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
+        ANONYMOUS_PAT: ${{ secrets.ECMWF_DATASTORES_ANON_KEY }}
       run: |
         make ci-integration-tests COV_REPORT=xml
 

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
   - id: blackdoc
     additional_dependencies: [black==23.11.0]
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.11.8
+  rev: v0.11.12
   hooks:
   - id: ruff
     args: [--fix, --show-fixes]
@@ -34,6 +34,11 @@ repos:
   - id: pretty-format-toml
     args: [--autofix]
 - repo: https://github.com/gitleaks/gitleaks
-  rev: v8.25.1
+  rev: v8.27.0
   hooks:
   - id: gitleaks
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.8.1
+  hooks:
+  - id: nbstripout
+    args: [--drop-empty-cells]

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/Makefile

@@ -26,6 +26,7 @@ docker-run:
 	docker run --rm -ti -v $(PWD):/srv $(PROJECT)
 
 template-update:
+	pre-commit autoupdate --repo https://github.com/kynan/nbstripout
 	pre-commit run --all-files cruft -c .pre-commit-config-cruft.yaml
 
 docs-build:

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecmwf-datastores-client
-Version: 0.1.0
+Version: 0.3.0
 Summary: ECMWF Data Stores Service (DSS) API Python client
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -228,25 +228,20 @@ Requires-Dist: multiurl>=0.3.2
 Requires-Dist: requests
 Requires-Dist: typing-extensions
 Provides-Extra: legacy
-Requires-Dist: cdsapi>=0.7.5; extra == "legacy"
+Requires-Dist: cdsapi>=0.7.6; extra == "legacy"
 Dynamic: license-file
 
 <p align="center">
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE">
-  </a>
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE"></a>
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level">
-  </a>
-  <!-- <a href="https://codecov.io/gh/ecmwf/earthkit">
-    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage">
-  </a> -->
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level"></a>
+  <!-- <a href="https://codecov.io/gh/ecmwf/ecmwf-datastores-client">
+    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage"></a> -->
   <a href="https://opensource.org/licenses/apache-2-0">
-    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
-  </a>
-  <a href="https://github.com/ecmwf/earthkit/releases">
-    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release">
-  </a>
+    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence"></a>
+  <a href="https://github.com/ecmwf/ecmwf-datastores-client/releases">
+    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release"></a>
 </p>
 
 <p align="center">
@@ -282,8 +277,11 @@ $ pip install ecmwf-datastores-client
 
 ## Configuration
 
-The `Client` requires the `url` to the API root and a valid API `key`. You can also set the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables, or use a configuration file.
-The configuration file must be located at `~/.ecmwfdatastoresrc`, or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
+The `Client` requires the `url` to the API root and a valid API `key`. These can be provided in three ways, in order of precedence:
+
+1. As keyword arguments when instantiating the `Client`.
+1. Via the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables.
+1. From a configuration file, which must be located at `~/.ecmwfdatastoresrc` or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
 
 ```
 $ cat $HOME/.ecmwfdatastoresrc
@@ -291,14 +289,6 @@ url: https://cds.climate.copernicus.eu/api
 key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 ```
 
-It is possible (though not recommended) to use the API key of one of the test users:
-
-```
-00112233-4455-6677-c899-aabbccddeeff
-```
-
-This key is used for anonymous tests and is designed to be the least performant option for accessing the system.
-
 ## Quick Start
 
 Configure the logging level to display INFO messages:
@@ -312,12 +302,8 @@ Configure the logging level to display INFO messages:
 Instantiate the API client and optionally verify authentication:
 
 ```python
->>> import os
 >>> from ecmwf.datastores import Client
->>> client = Client(
-...     url=os.getenv("ECMWF_DATASTORES_URL"),
-...     key=os.getenv("ECMWF_DATASTORES_KEY"),
-... )
+>>> client = Client()
 >>> client.check_authentication()  # optional check
 {...}
 

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/README.md

@@ -1,19 +1,14 @@
 <p align="center">
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE">
-  </a>
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE"></a>
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level">
-  </a>
-  <!-- <a href="https://codecov.io/gh/ecmwf/earthkit">
-    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage">
-  </a> -->
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level"></a>
+  <!-- <a href="https://codecov.io/gh/ecmwf/ecmwf-datastores-client">
+    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage"></a> -->
   <a href="https://opensource.org/licenses/apache-2-0">
-    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
-  </a>
-  <a href="https://github.com/ecmwf/earthkit/releases">
-    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release">
-  </a>
+    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence"></a>
+  <a href="https://github.com/ecmwf/ecmwf-datastores-client/releases">
+    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release"></a>
 </p>
 
 <p align="center">
@@ -49,8 +44,11 @@ $ pip install ecmwf-datastores-client
 
 ## Configuration
 
-The `Client` requires the `url` to the API root and a valid API `key`. You can also set the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables, or use a configuration file.
-The configuration file must be located at `~/.ecmwfdatastoresrc`, or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
+The `Client` requires the `url` to the API root and a valid API `key`. These can be provided in three ways, in order of precedence:
+
+1. As keyword arguments when instantiating the `Client`.
+1. Via the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables.
+1. From a configuration file, which must be located at `~/.ecmwfdatastoresrc` or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
 
 ```
 $ cat $HOME/.ecmwfdatastoresrc
@@ -58,14 +56,6 @@ url: https://cds.climate.copernicus.eu/api
 key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 ```
 
-It is possible (though not recommended) to use the API key of one of the test users:
-
-```
-00112233-4455-6677-c899-aabbccddeeff
-```
-
-This key is used for anonymous tests and is designed to be the least performant option for accessing the system.
-
 ## Quick Start
 
 Configure the logging level to display INFO messages:
@@ -79,12 +69,8 @@ Configure the logging level to display INFO messages:
 Instantiate the API client and optionally verify authentication:
 
 ```python
->>> import os
 >>> from ecmwf.datastores import Client
->>> client = Client(
-...     url=os.getenv("ECMWF_DATASTORES_URL"),
-...     key=os.getenv("ECMWF_DATASTORES_KEY"),
-... )
+>>> client = Client()
 >>> client.check_authentication()  # optional check
 {...}
 

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ci/environment-ci.yml

@@ -14,8 +14,9 @@ dependencies:
 - sphinx
 - sphinx-autoapi
 # DO NOT EDIT ABOVE THIS LINE, ADD DEPENDENCIES BELOW
+- ipykernel
+- nbsphinx
 - types-requests
 - pip:
-  # TODO: install from pypi or conda when available
-  - git+https://github.com/bopen/cdsapi.git@COPDS-2640
+  - cdsapi >= 0.7.6
   - responses

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/docs/conf.py

@@ -29,6 +29,7 @@ release = ecmwf.datastores.__version__
 extensions = [
     "autoapi.extension",
     "myst_parser",
+    "nbsphinx",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
 ]

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/docs/index.md

@@ -11,6 +11,7 @@ Knowledge Base.
 :maxdepth: 2
 
 README.md
+notebooks/index
 API Reference <_api/datastores/index>
 ```
 

ecmwf_datastores_client-0.3.0/docs/notebooks/index.md

@@ -0,0 +1,7 @@
+# Notebooks
+
+```{toctree}
+:maxdepth: 1
+
+quick_start
+```

ecmwf_datastores_client-0.3.0/docs/notebooks/quick_start.ipynb

@@ -0,0 +1,45 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": [
+    "# Quick start"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ecmwf.datastores import Client\n",
+    "\n",
+    "client = Client()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.11"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/catalogue.py

@@ -15,7 +15,6 @@
 from __future__ import annotations
 
 import datetime
-import warnings
 from typing import Any, Callable
 
 import attrs
@@ -93,16 +92,6 @@ class Collection(ApiResponse):
         url = self._get_link_href(rel="retrieve")
         return datastores.Process.from_request("get", url, **self._request_kwargs)
 
-    @property
-    def process(self) -> datastores.Process:
-        warnings.warn(
-            "`process` has been deprecated, and in the future will raise an error."
-            "Please use `submit` and `apply_constraints` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self._process
-
     @property
     def form(self) -> list[dict[str, Any]]:
         url = f"{self.url}/form.json"

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/client.py

@@ -28,6 +28,8 @@ from ecmwf.datastores.catalogue import Catalogue
 from ecmwf.datastores.processing import Processing, RequestKwargs
 from ecmwf.datastores.profile import Profile
 
+T_STATUS = Literal["accepted", "running", "successful", "failed", "rejected"]
+
 
 @attrs.define(slots=False)
 class Client:
@@ -179,6 +181,21 @@ class Client:
         """
         return self._profile_api.check_authentication()
 
+    def delete(self, *request_ids: str) -> dict[str, Any]:
+        """Delete requests.
+
+        Parameters
+        ----------
+        *request_ids: str
+            Request IDs.
+
+        Returns
+        -------
+        dict[str,Any]
+            Content of the response.
+        """
+        return self._retrieve_api.delete(*request_ids)
+
     def download_results(self, request_id: str, target: str | None = None) -> str:
         """Download the results of a request.
 
@@ -234,7 +251,7 @@ class Client:
         Parameters
         ----------
         limit: int | None
-            Number of processes per page.
+            Number of collections per page.
         sortby: {None, 'id', 'relevance', 'title', 'update'}
             Field to sort results by.
         query: str or None
@@ -259,17 +276,17 @@ class Client:
         self,
         limit: int | None = None,
         sortby: Literal[None, "created", "-created"] = None,
-        status: Literal[None, "accepted", "running", "successful", "failed"] = None,
+        status: None | T_STATUS | list[T_STATUS] = None,
     ) -> datastores.Jobs:
         """Retrieve submitted jobs.
 
         Parameters
         ----------
         limit: int or None
-            Number of processes per page.
+            Number of jobs per page.
         sortby: {None, 'created', '-created'}
             Field to sort results by.
-        status: {None, 'accepted', 'running', 'successful', 'failed'}
+        status: None or {'accepted', 'running', 'successful', 'failed', 'rejected'} or list
             Status of the results.
 
         Returns

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/processing.py

@@ -400,16 +400,6 @@ class Remote:
         """Request ID."""
         return self.url.rpartition("/")[2]
 
-    @property
-    def request_uid(self) -> str:
-        warnings.warn(
-            "`request_uid` has been deprecated, and in the future will raise an error."
-            "Please use `request_id` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.request_id
-
     @property
     def json(self) -> dict[str, Any]:
         """Content of the response."""
@@ -450,48 +440,18 @@ class Remote:
         """When the job was created."""
         return utils.string_to_datetime(self.json["created"])
 
-    @property
-    def creation_datetime(self) -> datetime.datetime:
-        warnings.warn(
-            "`creation_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `created_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.created_at
-
     @property
     def started_at(self) -> datetime.datetime | None:
         """When the job started. If None, the job has not started."""
         value = self.json.get("started")
         return value if value is None else utils.string_to_datetime(value)
 
-    @property
-    def start_datetime(self) -> datetime.datetime | None:
-        warnings.warn(
-            "`start_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `started_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.started_at
-
     @property
     def finished_at(self) -> datetime.datetime | None:
         """When the job finished. If None, the job has not finished."""
         value = self.json.get("finished")
         return value if value is None else utils.string_to_datetime(value)
 
-    @property
-    def end_datetime(self) -> datetime.datetime | None:
-        warnings.warn(
-            "`end_datetime` has been deprecated, and in the future will raise an error."
-            "Please use `finished_at` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.finished_at
-
     def _wait_on_results(self) -> None:
         sleep = 1.0
         while not self.results_ready:
@@ -507,7 +467,7 @@ class Remote:
             return True
         if status in ("accepted", "running"):
             return False
-        if status == "failed":
+        if status in ("failed", "rejected"):
             results = self._make_results(wait=False)
             raise ProcessingFailedError(error_json_to_message(results._json_dict))
         if status in ("dismissed", "deleted"):
@@ -525,15 +485,6 @@ class Remote:
         results = Results.from_request("get", results_url, **self._request_kwargs)
         return results
 
-    def make_results(self, wait: bool = True) -> Results:
-        warnings.warn(
-            "`make_results` has been deprecated, and in the future will raise an error."
-            "Please use `get_results` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self._make_results(wait)
-
     def get_results(self) -> Results:
         """Retrieve results.
 
@@ -641,15 +592,6 @@ class Job(ApiResponse):
             url = self._get_link_href(rel="self")
         return Remote(url, **self._request_kwargs)
 
-    def make_remote(self) -> Remote:
-        warnings.warn(
-            "`make_remote` has been deprecated, and in the future will raise an error."
-            "Please use `get_remote` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.get_remote()
-
 
 @attrs.define
 class Jobs(ApiResponsePaginated):
@@ -660,16 +602,6 @@ class Jobs(ApiResponsePaginated):
         """List of request IDs."""
         return [job["jobID"] for job in self._json_dict["jobs"]]
 
-    @property
-    def request_uids(self) -> list[str]:
-        warnings.warn(
-            "`request_uids` has been deprecated, and in the future will raise an error."
-            "Please use `request_ids` from now on.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        return self.request_ids
-
 
 @attrs.define
 class Results(ApiResponse):
@@ -773,6 +705,13 @@ class Processing:
             log_callback=self.log_callback,
         )
 
+    def delete(self, *job_ids: str) -> dict[str, Any]:
+        url = f"{self.url}/jobs/delete"
+        response = ApiResponse.from_request(
+            "post", url, json={"job_ids": job_ids}, **self._request_kwargs
+        )
+        return response._json_dict
+
     def get_processes(self, **params: Any) -> Processes:
         url = f"{self.url}/processes"
         return Processes.from_request("get", url, params=params, **self._request_kwargs)

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf/datastores/version.py

@@ -1,2 +1,2 @@
 # Do not change! Do not track in version control!
-__version__ = "0.1.0"
+__version__ = "0.3.0"

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf_datastores_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecmwf-datastores-client
-Version: 0.1.0
+Version: 0.3.0
 Summary: ECMWF Data Stores Service (DSS) API Python client
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -228,25 +228,20 @@ Requires-Dist: multiurl>=0.3.2
 Requires-Dist: requests
 Requires-Dist: typing-extensions
 Provides-Extra: legacy
-Requires-Dist: cdsapi>=0.7.5; extra == "legacy"
+Requires-Dist: cdsapi>=0.7.6; extra == "legacy"
 Dynamic: license-file
 
 <p align="center">
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE">
-  </a>
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/ESEE/data_provision_badge.svg" alt="ECMWF Software EnginE"></a>
   <a href="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity">
-    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level">
-  </a>
-  <!-- <a href="https://codecov.io/gh/ecmwf/earthkit">
-    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage">
-  </a> -->
+    <img src="https://github.com/ecmwf/codex/raw/refs/heads/main/Project Maturity/incubating_badge.svg" alt="Maturity Level"></a>
+  <!-- <a href="https://codecov.io/gh/ecmwf/ecmwf-datastores-client">
+    <img src="https://codecov.io/gh/ecmwf/ecmwf-datastores-client/branch/main/graph/badge.svg" alt="Code Coverage"></a> -->
   <a href="https://opensource.org/licenses/apache-2-0">
-    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence">
-  </a>
-  <a href="https://github.com/ecmwf/earthkit/releases">
-    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release">
-  </a>
+    <img src="https://img.shields.io/badge/Licence-Apache 2.0-blue.svg" alt="Licence"></a>
+  <a href="https://github.com/ecmwf/ecmwf-datastores-client/releases">
+    <img src="https://img.shields.io/github/v/release/ecmwf/ecmwf-datastores-client?color=purple&label=Release" alt="Latest Release"></a>
 </p>
 
 <p align="center">
@@ -282,8 +277,11 @@ $ pip install ecmwf-datastores-client
 
 ## Configuration
 
-The `Client` requires the `url` to the API root and a valid API `key`. You can also set the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables, or use a configuration file.
-The configuration file must be located at `~/.ecmwfdatastoresrc`, or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
+The `Client` requires the `url` to the API root and a valid API `key`. These can be provided in three ways, in order of precedence:
+
+1. As keyword arguments when instantiating the `Client`.
+1. Via the `ECMWF_DATASTORES_URL` and `ECMWF_DATASTORES_KEY` environment variables.
+1. From a configuration file, which must be located at `~/.ecmwfdatastoresrc` or at the path specified by the `ECMWF_DATASTORES_RC_FILE` environment variable.
 
 ```
 $ cat $HOME/.ecmwfdatastoresrc
@@ -291,14 +289,6 @@ url: https://cds.climate.copernicus.eu/api
 key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
 ```
 
-It is possible (though not recommended) to use the API key of one of the test users:
-
-```
-00112233-4455-6677-c899-aabbccddeeff
-```
-
-This key is used for anonymous tests and is designed to be the least performant option for accessing the system.
-
 ## Quick Start
 
 Configure the logging level to display INFO messages:
@@ -312,12 +302,8 @@ Configure the logging level to display INFO messages:
 Instantiate the API client and optionally verify authentication:
 
 ```python
->>> import os
 >>> from ecmwf.datastores import Client
->>> client = Client(
-...     url=os.getenv("ECMWF_DATASTORES_URL"),
-...     key=os.getenv("ECMWF_DATASTORES_KEY"),
-... )
+>>> client = Client()
 >>> client.check_authentication()  # optional check
 {...}
 

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf_datastores_client.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ Makefile
 README.md
 environment.yml
 pyproject.toml
+.github/workflows/on-pr-closed.yml
 .github/workflows/on-push.yml
 ci/environment-ci.yml
 ci/environment-integration.yml
@@ -17,6 +18,8 @@ docs/index.md
 docs/make.bat
 docs/_static/.gitkeep
 docs/_templates/.gitkeep
+docs/notebooks/index.md
+docs/notebooks/quick_start.ipynb
 ecmwf/datastores/__init__.py
 ecmwf/datastores/catalogue.py
 ecmwf/datastores/client.py
@@ -38,8 +41,8 @@ tests/integration_test_20_processing.py
 tests/integration_test_30_remote.py
 tests/integration_test_40_results.py
 tests/integration_test_50_profile.py
-tests/integration_test_60_api_client.py
-tests/integration_test_70_legacy_api_client.py
+tests/integration_test_60_client.py
+tests/integration_test_70_legacy_client.py
 tests/integration_test_80_adaptors.py
 tests/integration_test_90_features.py
 tests/test_00_version.py

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/ecmwf_datastores_client.egg-info/requires.txt

@@ -4,4 +4,4 @@ requests
 typing-extensions
 
 [legacy]
-cdsapi>=0.7.5
+cdsapi>=0.7.6

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/pyproject.toml

@@ -32,7 +32,7 @@ readme = "README.md"
 requires-python = ">=3.8"
 
 [project.optional-dependencies]
-legacy = ["cdsapi >= 0.7.5"]
+legacy = ["cdsapi >= 0.7.6"]
 
 [project.urls]
 documentation = "https://ecmwf.github.io/ecmwf-datastores-client/"

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/tests/conftest.py

@@ -21,10 +21,7 @@ def api_root_url() -> str:
 
 @pytest.fixture
 def api_anon_key() -> str:
-    return os.getenv(
-        "ECMWF_DATASTORES_ANON_KEY",
-        "00112233-4455-6677-c899-aabbccddeeff",  # gitleaks:allow
-    )
+    return os.getenv("ANONYMOUS_PAT", "00112233-4455-6677-c899-aabbccddeeff")
 
 
 @pytest.fixture

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/tests/integration_test_20_processing.py

@@ -75,9 +75,10 @@ def test_processing_get_jobs_sortby(api_anon_client: Client) -> None:
     assert [id2] != api_anon_client.get_jobs(sortby="created", limit=1).request_ids
 
 
-def test_deprecation_warnings(api_anon_client: Client) -> None:
-    with pytest.warns(DeprecationWarning):
-        api_anon_client.submit("test-adaptor-dummy", {}).request_uid
-
-    with pytest.warns(DeprecationWarning):
-        api_anon_client.get_jobs().request_uids
+def test_processing_delete(api_anon_client: Client) -> None:
+    id1 = api_anon_client.submit("test-adaptor-dummy", {}).request_id
+    id2 = api_anon_client.submit("test-adaptor-dummy", {}).request_id
+    job1, job2 = api_anon_client.delete(id1, id2)["jobs"]
+    assert job1["status"] == job2["status"] == "dismissed"
+    assert job1["jobID"] == id1
+    assert job2["jobID"] == id2

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/tests/integration_test_30_remote.py

@@ -106,9 +106,3 @@ def test_remote_datetimes(api_anon_client: Client) -> None:
     assert remote.finished_at is not None
     assert remote.created_at < remote.started_at < remote.finished_at
     assert remote.finished_at == remote.updated_at
-
-
-def test_make_results_deprecation(api_anon_client: Client) -> None:
-    remote = api_anon_client.submit("test-adaptor-dummy", {})
-    with pytest.warns(DeprecationWarning, match="`make_results` has been deprecated"):
-        remote.make_results()

ecmwf_datastores_client-0.1.0/tests/integration_test_60_api_client.py → ecmwf_datastores_client-0.3.0/tests/integration_test_60_client.py

@@ -9,7 +9,7 @@ from urllib3.exceptions import InsecureRequestWarning
 from ecmwf.datastores import Client, Remote, Results, processing
 
 
-def test_api_client_download_results(
+def test_client_download_results(
     api_anon_client: Client, tmp_path: pathlib.Path
 ) -> None:
     remote = api_anon_client.submit("test-adaptor-dummy", {})
@@ -20,27 +20,27 @@ def test_api_client_download_results(
     assert os.path.exists(result)
 
 
-def test_api_client_get_process(api_anon_client: Client) -> None:
+def test_client_get_process(api_anon_client: Client) -> None:
     process = api_anon_client.get_process("test-adaptor-dummy")
     assert isinstance(process, processing.Process)
     assert process.id == "test-adaptor-dummy"
     assert set(process.headers) == {"User-Agent", "PRIVATE-TOKEN"}
 
 
-def test_api_client_get_remote(api_anon_client: Client) -> None:
+def test_client_get_remote(api_anon_client: Client) -> None:
     request_id = api_anon_client.submit("test-adaptor-dummy", {}).request_id
     remote = api_anon_client.get_remote(request_id)
     assert remote.request_id == request_id
     assert set(remote.headers) == {"User-Agent", "PRIVATE-TOKEN"}
 
 
-def test_api_client_get_results(api_anon_client: Client) -> None:
+def test_client_get_results(api_anon_client: Client) -> None:
     request_id = api_anon_client.submit("test-adaptor-dummy", {}).request_id
     results = api_anon_client.get_results(request_id)
     assert isinstance(results, Results)
 
 
-def test_api_client_retrieve(
+def test_client_retrieve(
     api_anon_client: Client,
     tmp_path: pathlib.Path,
 ) -> None:
@@ -54,24 +54,24 @@ def test_api_client_retrieve(
     assert os.path.getsize(actual_target) == 1
 
 
-def test_api_client_submit(api_anon_client: Client) -> None:
+def test_client_submit(api_anon_client: Client) -> None:
     remote = api_anon_client.submit("test-adaptor-dummy", {})
     assert isinstance(remote, Remote)
 
 
-def test_api_client_submit_and_wait_on_results(api_anon_client: Client) -> None:
+def test_client_submit_and_wait_on_results(api_anon_client: Client) -> None:
     results = api_anon_client.submit_and_wait_on_results("test-adaptor-dummy", {})
     assert isinstance(results, Results)
 
 
-def test_api_client_verify(api_root_url: str, api_anon_key: str) -> None:
+def test_client_verify(api_root_url: str, api_anon_key: str) -> None:
     if not api_root_url.startswith("https"):
         pytest.skip(f"{api_root_url=} does not use https protocol")
     with pytest.warns(InsecureRequestWarning):
         Client(url=api_root_url, key=api_anon_key, verify=False, maximum_tries=0)
 
 
-def test_api_client_timeout(
+def test_client_timeout(
     api_root_url: str,
     api_anon_key: str,
     tmp_path: pathlib.Path,

ecmwf_datastores_client-0.1.0/tests/integration_test_70_legacy_api_client.py → ecmwf_datastores_client-0.3.0/tests/integration_test_70_legacy_client.py

@@ -54,7 +54,7 @@ def legacy_update(remote: processing.Remote) -> None:
             )
 
 
-def test_legacy_api_client_retrieve(
+def test_legacy_client_retrieve(
     tmp_path: pathlib.Path, legacy_client: LegacyClient
 ) -> None:
     collection_id = "test-adaptor-dummy"
@@ -65,7 +65,7 @@ def test_legacy_api_client_retrieve(
     assert os.path.getsize(target) == 1
 
 
-def test_legacy_api_client_result(
+def test_legacy_client_result(
     monkeypatch: pytest.MonkeyPatch,
     tmp_path: pathlib.Path,
     legacy_client: LegacyClient,
@@ -92,7 +92,7 @@ def test_legacy_api_client_result(
 
 
 @pytest.mark.parametrize("quiet", [True, False])
-def test_legacy_api_client_quiet(
+def test_legacy_client_quiet(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -105,7 +105,7 @@ def test_legacy_api_client_quiet(
 
 
 @pytest.mark.parametrize("debug", [True, False])
-def test_legacy_api_client_debug(
+def test_legacy_client_debug(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -120,7 +120,7 @@ def test_legacy_api_client_debug(
     "wait_until_complete,expected_type",
     [(True, processing.Results), (False, processing.Remote)],
 )
-def test_legacy_api_client_wait_until_complete(
+def test_legacy_client_wait_until_complete(
     tmp_path: pathlib.Path,
     api_root_url: str,
     api_anon_key: str,
@@ -156,7 +156,7 @@ def test_legacy_api_client_wait_until_complete(
         ),
     ],
 )
-def test_legacy_api_client_update(
+def test_legacy_client_update(
     api_root_url: str,
     api_anon_key: str,
     collection_id: str,
@@ -173,7 +173,7 @@ def test_legacy_api_client_update(
 
 
 @pytest.mark.filterwarnings("ignore:Unverified HTTPS")
-def test_legacy_api_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
+def test_legacy_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
     session = requests.Session()
     client = LegacyClient(
         url=api_root_url,
@@ -198,7 +198,7 @@ def test_legacy_api_client_kwargs(api_root_url: str, api_anon_key: str) -> None:
     assert client.client.session is session
 
 
-def test_legacy_api_client_logging(
+def test_legacy_client_logging(
     caplog: pytest.LogCaptureFixture,
     api_root_url: str,
     api_anon_key: str,
@@ -226,7 +226,7 @@ def test_legacy_api_client_logging(
         ]
 
 
-def test_legacy_api_client_download(
+def test_legacy_client_download(
     tmp_path: pathlib.Path,
     monkeypatch: pytest.MonkeyPatch,
     api_root_url: str,
@@ -258,7 +258,7 @@ def test_legacy_api_client_download(
     assert all(os.path.getsize(target) == 1 for target in targets)
 
 
-def test_legacy_api_client_status(legacy_client: LegacyClient) -> None:
+def test_legacy_client_status(legacy_client: LegacyClient) -> None:
     status = legacy_client.status()
     assert set(status) <= {
         "critical",
@@ -277,7 +277,7 @@ def test_legacy_api_client_status(legacy_client: LegacyClient) -> None:
     )
 
 
-def test_legacy_api_client_remote(
+def test_legacy_client_remote(
     legacy_client: LegacyClient, tmp_path: pathlib.Path
 ) -> None:
     results = legacy_client.retrieve("test-adaptor-dummy", {"size": 1})
@@ -288,7 +288,7 @@ def test_legacy_api_client_remote(
     assert os.path.getsize(target) == 1
 
 
-def test_legacy_api_client_warning(
+def test_legacy_client_warning(
     api_root_url: str,
     api_anon_key: str,
 ) -> None:
@@ -305,7 +305,7 @@ def test_legacy_api_client_warning(
         )
 
 
-def test_legacy_api_client_toolbox(legacy_client: LegacyClient) -> None:
+def test_legacy_client_toolbox(legacy_client: LegacyClient) -> None:
     with pytest.raises(NotImplementedError):
         legacy_client.service("service")
     with pytest.raises(NotImplementedError):

{ecmwf_datastores_client-0.1.0 → ecmwf_datastores_client-0.3.0}/tests/test_20_processing.py

@@ -389,33 +389,6 @@ def test_submit(cat: catalogue.Catalogue) -> None:
     assert remote.finished_at.isoformat() == "2022-09-02T17:32:54.308120+00:00"
 
 
-@responses.activate
-def test_depracations(cat: catalogue.Catalogue) -> None:
-    responses_add()
-
-    collection = cat.get_collection(COLLECTION_ID)
-    with pytest.warns(DeprecationWarning, match="`process` has been deprecated"):
-        assert isinstance(collection.process, processing.Process)
-
-    request = {"variable": "temperature", "year": "2022"}
-    remote = collection.submit(request)
-
-    with pytest.warns(
-        DeprecationWarning, match="`creation_datetime` has been deprecated"
-    ):
-        assert (
-            remote.creation_datetime.isoformat() == "2022-09-02T17:30:48.201213+00:00"
-        )
-
-    with pytest.warns(DeprecationWarning, match="`start_datetime` has been deprecated"):
-        assert remote.start_datetime is not None
-        assert remote.start_datetime.isoformat() == "2022-09-02T17:32:43.890617+00:00"
-
-    with pytest.warns(DeprecationWarning, match="`end_datetime` has been deprecated"):
-        assert remote.end_datetime is not None
-        assert remote.end_datetime.isoformat() == "2022-09-02T17:32:54.308120+00:00"
-
-
 @responses.activate
 @pytest.mark.parametrize("method", ("submit", "apply_constraints", "estimate_costs"))
 def test_process_docstrings(cat: catalogue.Catalogue, method: str) -> None:
@@ -438,8 +411,12 @@ def test_wait_on_result(cat: catalogue.Catalogue) -> None:
     remote._wait_on_results()
 
 
+@pytest.mark.parametrize("status", ["failed", "rejected"])
 @responses.activate
-def test_wait_on_result_failed(cat: catalogue.Catalogue) -> None:
+def test_wait_on_result_failed(
+    cat: catalogue.Catalogue, status: str, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    monkeypatch.setitem(JOB_FAILED_JSON, "status", status)
     responses_add()
 
     collection = cat.get_collection(COLLECTION_ID)
@@ -451,6 +428,7 @@ def test_wait_on_result_failed(cat: catalogue.Catalogue) -> None:
     ):
         remote._wait_on_results()
 
+    assert remote.status == status
     assert remote.created_at.isoformat() == "2022-09-02T17:30:48.201213+00:00"
     assert remote.started_at is not None
     assert remote.started_at.isoformat() == "2022-09-02T17:32:43.890617+00:00"