datalab-api 0.3.1__tar.gz → 0.3.2__tar.gz

{datalab_api-0.3.1/src/datalab_api.egg-info → datalab_api-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datalab-api
-Version: 0.3.1
+Version: 0.3.2
 Summary: A Python API for instances of the datalab data management platform (https://github.com/datalab-org/datalab).
 Author-email: Matthew Evans <matthew@ml-evs.science>
 License-Expression: MIT
@@ -61,7 +61,7 @@ A simple Python API that can interact with [*datalab*](https://github.com/datala
 
 The idea here is to provide a set of utility functions and models for manipulating samples, cells, inventory, files, users and metadata associated with *datalab* entries in an automated way.
 
-This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io/en/stable/rest_api/).
+This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io).
 This means that the API is primarily *functional* in nature, as opposed to object-oriented, since *datalab* instances are free to use their own custom data models.
 The available schemas are reported as instance metadata and in the future object-oriented models may be able to be genereated directly in the client (so e.g., the returned data would be Python objects like `Sample` rather than JSON data).
 

{datalab_api-0.3.1 → datalab_api-0.3.2}/README.md

@@ -14,7 +14,7 @@ A simple Python API that can interact with [*datalab*](https://github.com/datala
 
 The idea here is to provide a set of utility functions and models for manipulating samples, cells, inventory, files, users and metadata associated with *datalab* entries in an automated way.
 
-This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io/en/stable/rest_api/).
+This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io).
 This means that the API is primarily *functional* in nature, as opposed to object-oriented, since *datalab* instances are free to use their own custom data models.
 The available schemas are reported as instance metadata and in the future object-oriented models may be able to be genereated directly in the client (so e.g., the returned data would be Python objects like `Sample` rather than JSON data).
 

{datalab_api-0.3.1 → datalab_api-0.3.2}/src/datalab_api/__init__.py

@@ -5,7 +5,7 @@ from collections.abc import Iterable
 from pathlib import Path
 from typing import Any, Optional, Union
 
-from ._base import BaseDatalabClient, DuplicateItemError, __version__
+from ._base import BaseDatalabClient, DatalabAPIError, DuplicateItemError, __version__
 
 __all__ = ("DatalabClient", "DuplicateItemError", "__version__")
 
@@ -150,6 +150,9 @@ class DatalabClient(BaseDatalabClient):
             except RuntimeError:
                 self.create_collection(collection_id)
                 collection_immutable_id = self.get_collection(collection_id)[0]["immutable_id"]
+            except DatalabAPIError:
+                self.create_collection(collection_id)
+                collection_immutable_id = self.get_collection(collection_id)[0]["immutable_id"]
             new_item["collections"] = new_item.get("collections", [])
             new_item["collections"].append({"immutable_id": collection_immutable_id})
 

{datalab_api-0.3.1 → datalab_api-0.3.2}/src/datalab_api/_base.py

@@ -2,6 +2,7 @@ import logging
 import os
 import re
 import warnings
+from getpass import getpass
 from importlib.metadata import version
 from typing import Any, Optional
 
@@ -37,6 +38,11 @@ class BaseDatalabClient(metaclass=AutoPrettyPrint):
     _headers: dict[str, str] = {}
     _timeout: httpx.Timeout = httpx.Timeout(10.0, read=60.0)
 
+    interactive: bool = True
+    """Whether the client is being used in an interactive context (e.g., CLI or notebook) or not.
+    Set to false if you want the script to error if no API key is found in the environment variables,
+    rather than prompting for input."""
+
     info: dict[str, Any] = {}
     """The `data` response from the `/info` endpoint of the Datalab API."""
 
@@ -189,9 +195,14 @@ class BaseDatalabClient(metaclass=AutoPrettyPrint):
                 api_key = api_key.strip("'").strip('"')
 
             if api_key is None:
-                raise ValueError(
-                    f"No API key found in environment variables {key_env_var}/<prefix>_{key_env_var}."
-                )
+                if self.interactive:
+                    api_key = getpass(
+                        f"Enter your API key for {self.datalab_api_url} (input will be hidden): "
+                    )
+                else:
+                    raise ValueError(
+                        f"No API key found in environment variables {key_env_var}/<prefix>_{key_env_var}."
+                    )
 
             self._api_key = api_key
 

{datalab_api-0.3.1 → datalab_api-0.3.2/src/datalab_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datalab-api
-Version: 0.3.1
+Version: 0.3.2
 Summary: A Python API for instances of the datalab data management platform (https://github.com/datalab-org/datalab).
 Author-email: Matthew Evans <matthew@ml-evs.science>
 License-Expression: MIT
@@ -61,7 +61,7 @@ A simple Python API that can interact with [*datalab*](https://github.com/datala
 
 The idea here is to provide a set of utility functions and models for manipulating samples, cells, inventory, files, users and metadata associated with *datalab* entries in an automated way.
 
-This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io/en/stable/rest_api/).
+This API may not expose all the functionality available in a given *datalab* instance, and the idea would be that this package can support multiple versions of the underlying [*datalab* REST API](https://docs.datalab-org.io).
 This means that the API is primarily *functional* in nature, as opposed to object-oriented, since *datalab* instances are free to use their own custom data models.
 The available schemas are reported as instance metadata and in the future object-oriented models may be able to be genereated directly in the client (so e.g., the returned data would be Python objects like `Sample` rather than JSON data).