Add endpoint_url and cds_api_key to params schema

Addresses #65

Author: pont-us

examples/notebooks/Ex0-DCFS-Setup.ipynb

@@ -0,0 +1,80 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## ESA CCI Open Data Portal / xcube Integration Setup\n",
+    "\n",
+    "To run the Notebooks in this folder, you will need a Python environment with [`xcube`](https://github.com/dcs4cop/xcube) and the `xcube` plugin [`xcube_cci`](https://github.com/dcs4cop/xcube-cci) installed.\n",
+    "\n",
+    "### Installation\n",
+    "\n",
+    "For creating an `xcube` Python environment and installing `xcube` follow the instructions given in the [xcube's README](https://github.com/dcs4cop/xcube/blob/master/README.md).\n",
+    "For installing the `xcube_cci` plugin follow the instructions given in the [xcube-cci's README](https://github.com/dcs4cop/xcube-cci/blob/master/README.md).\n",
+    "\n",
+    "Before using Jupyter Lab for the first time install the `jupyterlab` package and make sure the \n",
+    "[Jupyter GeoJSON extension](https://www.npmjs.com/package/@jupyterlab/geojson-extension) is installed too:\n",
+    "\n",
+    "```bash\n",
+    "(xcube) conda install -c conda-forge jupyterlab\n",
+    "(xcube) jupyter labextension install @jupyterlab/geojson-extension\n",
+    "```\n",
+    "\n",
+    "### Running Juypter-Lab\n",
+    "\n",
+    "Start Jupyter Lab:\n",
+    "\n",
+    "```bash\n",
+    "(xcube) $ jupyter-lab\n",
+    "```\n",
+    "\n",
+    "### Test Setup\n",
+    "\n",
+    "Test whether setup was successful by importing some important `xcube_cci` exports:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'0.9.5'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from xcube_cci.version import version\n",
+    "version"
+   ]
+  }
+ ],
+ "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.9.10"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

test/test_store.py

@@ -45,6 +45,7 @@
 import os
 import re
 import tempfile
+import typing
 import unittest
 from collections.abc import Iterator
 
@@ -329,6 +330,18 @@ def test_client_url_and_key_rc_file(self):
         self.assertEqual(endpoint_url, client.url)
         self.assertEqual(cds_api_key, client.key)
 
+    def test_new_datastore_with_credential_parameters(self):
+        """Test passing URL and key parameters to new_data_store"""
+
+        from xcube.core.store import new_data_store
+        endpoint_url = 'https://example.com/'
+        cds_api_key = 'plugh'
+        store = typing.cast(CDSDataStore, new_data_store(
+            'cds', endpoint_url=endpoint_url, cds_api_key=cds_api_key
+        ))
+        self.assertEqual(endpoint_url, store.cds_api_url)
+        self.assertEqual(cds_api_key, store.cds_api_key)
+
     @staticmethod
     def _get_client(**opener_args):
         """Return the client instantiated to open a dataset

xcube_cds/store.py

@@ -752,6 +752,8 @@ def get_data_store_params_schema(cls) -> JsonObjectSchema:
         cds_params = dict(
             num_retries=JsonIntegerSchema(default=DEFAULT_NUM_RETRIES,
                                           minimum=0),
+            endpoint_url=JsonStringSchema(),
+            cds_api_key=JsonStringSchema(),
         )
 
         params.update(cds_params)