datacosmos 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

datacosmos/utils/http_response/check_api_response.py

@@ -0,0 +1,34 @@
+"""Validates an API response and raises a DatacosmosException if an error occurs."""
+
+from pydantic import ValidationError
+from requests import Response
+
+from datacosmos.exceptions.datacosmos_exception import DatacosmosException
+from datacosmos.utils.http_response.models.datacosmos_response import DatacosmosResponse
+
+
+def check_api_response(response: Response) -> None:
+    """Validates an API response and raises a DatacosmosException if an error occurs.
+
+    Args:
+        resp (requests.Response): The response object.
+
+    Raises:
+        DatacosmosException: If the response status code indicates an error.
+    """
+    if 200 <= response.status_code < 400:
+        return
+
+    try:
+        response = DatacosmosResponse.model_validate_json(response.text)
+        msg = response.errors[0].human_readable()
+        if len(response.errors) > 1:
+            msg = "\n  * " + "\n  * ".join(
+                error.human_readable() for error in response.errors
+            )
+        raise DatacosmosException(msg, response=response)
+
+    except ValidationError:
+        raise DatacosmosException(
+            f"HTTP {response.status_code}: {response.text}", response=response
+        )

datacosmos/utils/http_response/models/__init__.py

@@ -0,0 +1 @@
+"""Models for validation of API response."""

datacosmos/utils/http_response/models/datacosmos_error.py

@@ -0,0 +1,26 @@
+"""Structured API error message for Datacosmos."""
+
+from pydantic import BaseModel
+
+
+class DatacosmosError(BaseModel):
+    """Structured API error message for Datacosmos."""
+
+    message: str
+    field: str | None = None
+    type: str | None = None
+    source: str | None = None
+    trace_id: str | None = None
+
+    def human_readable(self) -> str:
+        """Formats the error message into a readable format."""
+        msg = self.message
+        if self.type:
+            msg += f" (type: {self.type})"
+        if self.field:
+            msg += f" (field: {self.field})"
+        if self.source:
+            msg += f" (source: {self.source})"
+        if self.trace_id:
+            msg += f" (trace_id: {self.trace_id})"
+        return msg

datacosmos/utils/http_response/models/datacosmos_response.py

@@ -0,0 +1,11 @@
+"""Structured response for Datacosmos handling multiple API errors."""
+
+from pydantic import BaseModel
+
+from datacosmos.utils.http_response.models.datacosmos_error import DatacosmosError
+
+
+class DatacosmosResponse(BaseModel):
+    """Structured response for Datacosmos handling multiple API errors."""
+
+    errors: list[DatacosmosError]

datacosmos/utils/missions.py

@@ -0,0 +1,27 @@
+"""Package for storing mission specific information."""
+
+from datacosmos.utils.constants import PROD_MISSION_NAMES, TEST_MISSION_NAMES
+
+
+def get_mission_name(mission: int, env: str) -> str:
+    """Get the mission name from the mission number."""
+    if env == "test" or env == "local":
+        return TEST_MISSION_NAMES[mission]
+    elif env == "prod":
+        return PROD_MISSION_NAMES[mission]
+    else:
+        raise ValueError(f"Unsupported environment: {env}")
+
+
+def get_mission_id(mission_name: str, env: str) -> int:
+    """Get the mission number from the mission name."""
+    if env == "test" or env == "local":
+        return {v.upper(): k for k, v in TEST_MISSION_NAMES.items()}[
+            mission_name.upper()
+        ]
+    elif env == "prod":
+        return {v.upper(): k for k, v in PROD_MISSION_NAMES.items()}[
+            mission_name.upper()
+        ]
+    else:
+        raise ValueError(f"Unsupported environment: {env}")

datacosmos/utils/url.py

@@ -0,0 +1,60 @@
+"""URL utility class for building and handling URLs in the SDK."""
+
+
+class URL:
+    """Class to represent and build URLs in a convenient way."""
+
+    def __init__(self, protocol: str, host: str, port: int, base: str):
+        """Creates a new basis to build URLs.
+
+        Args:
+            protocol (str): Protocol to use in the URL (http/https).
+            host (str): Hostname (e.g., example.com).
+            port (int): Port number.
+            base (str): Base path (e.g., /api/v1).
+        """
+        self.protocol = protocol
+        self.host = host
+        self.port = port
+        self.base = base
+
+    def string(self) -> str:
+        """Returns the full URL as a string."""
+        port = "" if self.port in [80, 443] else f":{self.port}"
+        base = f"/{self.base.lstrip('/')}" if self.base else ""
+        return f"{self.protocol}://{self.host}{port}{base}"
+
+    def with_suffix(self, suffix: str) -> str:
+        """Appends a suffix to the URL, ensuring proper formatting.
+
+        Args:
+            suffix (str): The path to append.
+
+        Returns:
+            str: Full URL with the suffix.
+        """
+        base = self.string()
+        return f"{base.rstrip('/')}/{suffix.lstrip('/')}"
+
+    def with_base(self, url: str) -> str:
+        """Replaces the base of the url with the base stored in the URL object. (migrates url from one base to another).
+
+        Args:
+            url (str): url to migrate to the base of the URL object
+
+        Returns (str):
+            url with the base of the URL object
+        """
+        split_url = url.split("/")
+        if len(split_url) < 3 or url.find("://") == -1:
+            raise ValueError(f"URL '{url}' does not meet the minimum requirements")
+        # get the whole path
+        url_path = "/".join(split_url[3:])
+        # simple case, matching self.base at url
+        b = self.base.lstrip("/")
+        if (base_pos := url_path.find(b)) != -1:
+            # remove the base from the url
+            url_suffix = url_path[len(b) + base_pos :]
+        else:
+            url_suffix = url_path
+        return self.with_suffix(url_suffix)

{datacosmos-0.0.1.dist-info → datacosmos-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: datacosmos
-Version: 0.0.1
+Version: 0.0.3
 Summary: A library for interacting with DataCosmos from Python code
 Author-email: Open Cosmos <support@open-cosmos.com>
 Classifier: Programming Language :: Python :: 3
@@ -20,3 +20,4 @@ Requires-Dist: pytest==7.2.0; extra == "dev"
 Requires-Dist: bandit[toml]==1.7.4; extra == "dev"
 Requires-Dist: isort==5.11.4; extra == "dev"
 Requires-Dist: pydocstyle==6.1.1; extra == "dev"
+Dynamic: license-file

datacosmos-0.0.3.dist-info/RECORD

@@ -0,0 +1,44 @@
+config/__init__.py,sha256=KCsaTb9-ZgFui1GM8wZFIPLJy0D0O8l8Z1Sv3NRD9UM,140
+config/config.py,sha256=h5XwNSA6QFBCDyennyFDNMAmbQOdtg8DsFAvjHlSEx4,7233
+config/models/__init__.py,sha256=r3lThPkyKjBjUZXRNscFzOrmn_-m_i9DvG3RePfCFYc,41
+config/models/m2m_authentication_config.py,sha256=1eJ_9df7Twn5WeWPbqMuR63ZdxhnTpBtKzqAPMnzP_k,565
+config/models/url.py,sha256=fwr2C06e_RDS8AWxOV_orVxMWhc57bzYoWSjFxQbkwg,835
+datacosmos/__init__.py,sha256=dVHKpbz5FVtfoJAWHRdsUENG6H-vs4UrkuwnIvOGJr4,66
+datacosmos/datacosmos_client.py,sha256=sivVYf45QEHTkUO62fnb1fnObKVmUngTR1Ga-ZRnoQE,4967
+datacosmos/exceptions/__init__.py,sha256=Crz8W7mOvPUXYcfDVotvjUt_3HKawBpmJA_-uel9UJk,45
+datacosmos/exceptions/datacosmos_exception.py,sha256=rKjJvQDvCEbxXWWccxB5GI_sth662bW8Yml0hX-vRw4,923
+datacosmos/stac/__init__.py,sha256=B4x_Mr4X7TzQoYtRC-VzI4W-fEON5WUOaz8cWJbk3Fc,214
+datacosmos/stac/stac_client.py,sha256=Cz_p96RmAgWX8t7Sye4OJRanQpCLihKStvfEw7IgYZc,472
+datacosmos/stac/collection/__init__.py,sha256=VQMLnsU3sER5kh4YxHrHP7XCA3DG1y0n9yoSmvycOY0,212
+datacosmos/stac/collection/collection_client.py,sha256=XTO2s309-cktJosvnwnFFXHDVmJc4vjvbEsZjpsCDmY,5904
+datacosmos/stac/collection/models/__init__.py,sha256=TQaihUS_CM9Eaekm4SbzFTNfv7BmabHv3Z-f37Py5Qs,40
+datacosmos/stac/collection/models/collection_update.py,sha256=Tqmfg4H4UQj5jsgy1dpKJCR59NSfWeiCSi9y8CY8-Cg,1656
+datacosmos/stac/enums/__init__.py,sha256=GUEL2xGtdjsrszrxivs0X6daxkaZs2JsTu2JoBtsvB4,22
+datacosmos/stac/enums/level.py,sha256=dqrkSRtoutMTWatGyRRUz3uNKVlNXn3qa_ubXNbw618,237
+datacosmos/stac/item/__init__.py,sha256=lRuD_yp-JxoLqBA23q0XMkCNImf4T-X3BJnSw9u_3Yk,200
+datacosmos/stac/item/item_client.py,sha256=E6zHf3ANzVXd5Di_u05mLen5-EOKTdCs0VKcXXJ6lUc,6826
+datacosmos/stac/item/models/__init__.py,sha256=bcOrOcIxGxGBrRVIyQVxSM3C3Xj_qzxIHgQeWo6f7Q8,34
+datacosmos/stac/item/models/asset.py,sha256=mvg_fenYCGOTMGwXXpK2nyqBk5RMsUYxl6KhQTWW_b0,631
+datacosmos/stac/item/models/datacosmos_item.py,sha256=jHuOkNvbVXUHdpplClPnA5mR4mcrfYQNm51EgQaVtNk,1704
+datacosmos/stac/item/models/eo_band.py,sha256=YC3Scn_wFhIo51pIVcJeuJienF7JGWoEv39JngDM6rI,309
+datacosmos/stac/item/models/item_update.py,sha256=_CpjQn9SsfedfuxlHSiGeptqY4M-p15t9YX__mBRueI,2088
+datacosmos/stac/item/models/raster_band.py,sha256=CoEVs-YyPE5Fse0He9DdOs4dGZpzfCsCuVzOcdXa_UM,354
+datacosmos/stac/item/models/search_parameters.py,sha256=yMmcb-Tr2as8585MD5wuZLWcqzwtRRkj07WBkootVS0,2022
+datacosmos/uploader/__init__.py,sha256=ZtfCVJ_pWKKh2F1r_NArnbG3_JtpcEiXcA_tmSwSKmQ,128
+datacosmos/uploader/datacosmos_uploader.py,sha256=LUtBDvAjZI7AYxKnC9TZQDP4z6lV2aHusz92XqivFGw,4398
+datacosmos/uploader/dataclasses/__init__.py,sha256=IjcyA8Vod-z1_Gi1FMZhK58Owman0foL25Hs0YtkYYs,43
+datacosmos/uploader/dataclasses/upload_path.py,sha256=WPl9u-oB-ti07ssKNDjL4vRQXhlOmLCgjt8MxFGrf3A,3153
+datacosmos/utils/__init__.py,sha256=XQbAnoqJrPpnSpEzAbjh84yqYWw8cBM8mNp8ynTG-54,50
+datacosmos/utils/constants.py,sha256=f7pOqCpdXk7WFGoaTyuCpr65jb-TtfhoVGuYTz3_T6Y,272
+datacosmos/utils/missions.py,sha256=7GOnrjxB8V11C_Jr3HHI4vpXifgkOSeirNjIDx17C58,940
+datacosmos/utils/url.py,sha256=iQwZr6mYRoePqUZg-k3KQSV9o2wju5ZuCa5WS_GyJo4,2114
+datacosmos/utils/http_response/__init__.py,sha256=BvOWwC5coYqq_kFn8gIw5m54TLpdfJKlW9vgRkfhXiA,33
+datacosmos/utils/http_response/check_api_response.py,sha256=dKWW01jn2_lWV0xpOBABhEP42CFSsx9dP0iSxykbN54,1186
+datacosmos/utils/http_response/models/__init__.py,sha256=Wj8YT6dqw7rAz_rctllxo5Or_vv8DwopvQvBzwCTvpw,45
+datacosmos/utils/http_response/models/datacosmos_error.py,sha256=Uqi2uM98nJPeCbM7zngV6vHSk97jEAb_nkdDEeUjiQM,740
+datacosmos/utils/http_response/models/datacosmos_response.py,sha256=oV4n-sue7K1wwiIQeHpxdNU8vxeqF3okVPE2rydw5W0,336
+datacosmos-0.0.3.dist-info/licenses/LICENSE.md,sha256=vpbRI-UUbZVQfr3VG_CXt9HpRnL1b5kt8uTVbirxeyI,1486
+datacosmos-0.0.3.dist-info/METADATA,sha256=ejuFFFnmdaInVXwXQtO6m35BQdTyotYYMLDVT-oWec4,843
+datacosmos-0.0.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+datacosmos-0.0.3.dist-info/top_level.txt,sha256=Iu5b533Fmdfz0rFKTnuBPjSUOQL2lEkTfHxsokP72s4,18
+datacosmos-0.0.3.dist-info/RECORD,,

{datacosmos-0.0.1.dist-info → datacosmos-0.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{datacosmos-0.0.1.dist-info → datacosmos-0.0.3.dist-info}/top_level.txt

@@ -1 +1,2 @@
+config
 datacosmos

datacosmos-0.0.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-datacosmos/__init__.py,sha256=dVHKpbz5FVtfoJAWHRdsUENG6H-vs4UrkuwnIvOGJr4,66
-datacosmos/datacosmos_client.py,sha256=sivVYf45QEHTkUO62fnb1fnObKVmUngTR1Ga-ZRnoQE,4967
-datacosmos-0.0.1.dist-info/LICENSE.md,sha256=vpbRI-UUbZVQfr3VG_CXt9HpRnL1b5kt8uTVbirxeyI,1486
-datacosmos-0.0.1.dist-info/METADATA,sha256=N8KMHCWaO8ED0OYT0hUikP31GgD1fB6SDpFuNAhL924,821
-datacosmos-0.0.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-datacosmos-0.0.1.dist-info/top_level.txt,sha256=ueobs5CNeyDbPMgXPcVV0d0yNdm8CvGtDT3CaksRVtA,11
-datacosmos-0.0.1.dist-info/RECORD,,