datacosmos 0.0.3__tar.gz → 0.0.4__tar.gz

{datacosmos-0.0.3/datacosmos.egg-info → datacosmos-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datacosmos
-Version: 0.0.3
+Version: 0.0.4
 Summary: A library for interacting with DataCosmos from Python code
 Author-email: Open Cosmos <support@open-cosmos.com>
 Classifier: Programming Language :: Python :: 3
@@ -13,6 +13,7 @@ Requires-Dist: oauthlib==3.2.0
 Requires-Dist: requests-oauthlib==1.3.1
 Requires-Dist: pydantic==2.10.6
 Requires-Dist: pystac==1.12.1
+Requires-Dist: pyyaml==6.0.2
 Provides-Extra: dev
 Requires-Dist: black==22.3.0; extra == "dev"
 Requires-Dist: ruff==0.9.5; extra == "dev"

{datacosmos-0.0.3 → datacosmos-0.0.4}/README.md

@@ -102,23 +102,165 @@ stac_client = STACClient(client)
 
 ### STACClient Methods
 
-#### 1. Fetch a Collection
+#### 1. **Search Items**
+```python
+from datacosmos.stac.item.models.catalog_search_parameters import CatalogSearchParameters
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+params = CatalogSearchParameters(
+     start_date="2/9/2025",
+     end_date="2/9/2025",
+     satellite=["MANTIS"],
+     product_type=["Satellite"],
+     processing_level=["L1A"]
+)
+
+items = list(stac_client.search_items(parameters=params, project_id="your-project-id"))
+```
+
+#### 2. **Fetch a Single Item**
+```python
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+item = stac_client.fetch_item(item_id="example-item", collection_id="example-collection")
+```
+
+#### 3. **Fetch All Items in a Collection**
+```python
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+items = stac_client.fetch_collection_items(collection_id="example-collection")
+```
+
+#### 4. **Create a New STAC Item**
+```python
+from pystac import Item, Asset
+from datetime import datetime
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+stac_item = Item(
+    id="new-item",
+    geometry={"type": "Point", "coordinates": [102.0, 0.5]},
+    bbox=[101.0, 0.0, 103.0, 1.0],
+    datetime=datetime.utcnow(),
+    properties={},
+    collection="example-collection"
+)
+
+stac_item.add_asset(
+    "image",
+    Asset(
+        href="https://example.com/sample-image.tiff",
+        media_type="image/tiff",
+        roles=["data"],
+        title="Sample Image"
+    )
+)
+
+stac_client.create_item(collection_id="example-collection", item=stac_item)
+```
+
+#### 5. **Update an Existing STAC Item**
+```python
+from datacosmos.stac.models.item_update import ItemUpdate
+from pystac import Asset, Link
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+update_payload = ItemUpdate(
+    properties={
+        "new_property": "updated_value",
+        "datetime": "2024-11-10T14:58:00Z"
+    },
+    assets={
+        "image": Asset(
+            href="https://example.com/updated-image.tiff",
+            media_type="image/tiff"
+        )
+    },
+    links=[
+        Link(rel="self", target="https://example.com/updated-image.tiff")
+    ],
+    geometry={
+        "type": "Point",
+        "coordinates": [10, 20]
+    },
+    bbox=[10.0, 20.0, 30.0, 40.0]
+)
 
+stac_client.update_item(item_id="new-item", collection_id="example-collection", update_data=update_payload)
+```
+
+#### 6. **Delete an Item**
 ```python
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
+stac_client.delete_item(item_id="new-item", collection_id="example-collection")
+```
+
+#### 7. Fetch a Collection
+
+```python
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
 collection = stac_client.fetch_collection("test-collection")
 ```
 
-#### 2. Fetch All Collections
+#### 8. Fetch All Collections
 
 ```python
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
 collections = list(stac_client.fetch_all_collections())
 ```
 
-#### 3. Create a Collection
+#### 9. Create a Collection
 
 ```python
 from pystac import Collection
 
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
 new_collection = Collection(
     id="test-collection",
     title="Test Collection",
@@ -133,11 +275,17 @@ new_collection = Collection(
 stac_client.create_collection(new_collection)
 ```
 
-#### 4. Update a Collection
+#### 10. Update a Collection
 
 ```python
 from datacosmos.stac.collection.models.collection_update import CollectionUpdate
 
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
 update_data = CollectionUpdate(
     title="Updated Collection Title",
     description="Updated description",
@@ -146,9 +294,16 @@ update_data = CollectionUpdate(
 stac_client.update_collection("test-collection", update_data)
 ```
 
-#### 5. Delete a Collection
+#### 11. Delete a Collection
 
 ```python
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+
 stac_client.delete_collection("test-collection")
 ```
 
@@ -161,6 +316,10 @@ You can use the `DatacosmosUploader` class to upload files to the DataCosmos clo
 ```python
 from datacosmos.uploader.datacosmos_uploader import DatacosmosUploader
 
+from datacosmos.datacosmos_client import DatacosmosClient
+
+client = DatacosmosClient()
+
 uploader = DatacosmosUploader(client)
 item_json_file_path = "/path/to/stac_item.json"
 uploader.upload_and_register_item(item_json_file_path)

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos/stac/collection/collection_client.py

@@ -6,6 +6,7 @@ from pystac import Collection, Extent, SpatialExtent, TemporalExtent
 from pystac.utils import str_to_datetime
 
 from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.exceptions.datacosmos_exception import DatacosmosException
 from datacosmos.stac.collection.models.collection_update import CollectionUpdate
 from datacosmos.utils.http_response.check_api_response import check_api_response
 
@@ -145,5 +146,8 @@ class CollectionClient:
         """
         try:
             return next_href.split("?")[1].split("=")[-1]
-        except (IndexError, AttributeError):
-            raise InvalidRequest(f"Failed to parse pagination token from {next_href}")
+        except (IndexError, AttributeError) as e:
+            raise DatacosmosException(
+                f"Failed to parse pagination token from {next_href}",
+                response=e.response,
+            ) from e

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos/stac/collection/models/collection_update.py

@@ -2,6 +2,7 @@
 
 Allows partial updates where only the provided fields are modified.
 """
+
 from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel, Field

datacosmos-0.0.4/datacosmos/stac/constants/__init__.py

@@ -0,0 +1 @@
+"""Constants for STAC."""

datacosmos-0.0.4/datacosmos/stac/constants/satellite_name_mapping.py

@@ -0,0 +1,20 @@
+"""Satellite name mapping."""
+
+SATELLITE_NAME_MAPPING = {
+    "GEOSAT-2": "2014-033D",
+    "SUPERVIEW-1-01": "2016-083A",
+    "SUPERVIEW-1-02": "2016-083B",
+    "SUPERVIEW-1-03": "2018-002A",
+    "SUPERVIEW-1-04": "2018-002B",
+    "MANTIS": "2023-174B",
+    "MENUT": "2023-001B",
+    "HAMMER": "2024-043BC",
+    "HAMMER-EM": "COSPAR-HAMMER-EM-TBD",
+    "Alisio": "2023-185M",
+    "Platero": "2023-174G",
+    "PHISAT-2": "2024-149C",
+    "PHISAT-2 EM": "COSPAR-PHISAT2-EM-TBD",
+    "Sentinel-2A": "2015-028A",
+    "Sentinel-2B": "2017-013A",
+    "Sentinel-2C": "2024-157A",
+}

datacosmos-0.0.4/datacosmos/stac/enums/processing_level.py

@@ -0,0 +1,15 @@
+"""Level enum class."""
+
+from enum import Enum
+
+
+class ProcessingLevel(Enum):
+    """Enum class for the processing levels of the data."""
+
+    L0 = "L0"
+    L1A = "L1A"
+    L2A = "L2A"
+    L1B = "L1B"
+    L1C = "L1C"
+    L1D = "L1D"
+    L3 = "L3"

datacosmos-0.0.4/datacosmos/stac/enums/product_type.py

@@ -0,0 +1,11 @@
+"""Product type enum class."""
+
+from enum import Enum
+
+
+class ProductType(str, Enum):
+    """Different product types."""
+
+    SATELLITE = "Satellite"
+    VECTOR = "Vector"
+    INSIGHT = "Insight"

datacosmos-0.0.4/datacosmos/stac/enums/season.py

@@ -0,0 +1,14 @@
+"""Season enum class."""
+
+from enum import Enum
+
+
+class Season(str, Enum):
+    """Different Open Cosmos seasons."""
+
+    SUMMER = "Summer"
+    WINTER = "Winter"
+    AUTUMN = "Autumn"
+    SPRING = "Spring"
+    RAINY = "Rainy"
+    DRY = "Dry"

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos/stac/item/item_client.py

@@ -9,6 +9,9 @@ from pystac import Item
 
 from datacosmos.datacosmos_client import DatacosmosClient
 from datacosmos.exceptions.datacosmos_exception import DatacosmosException
+from datacosmos.stac.item.models.catalog_search_parameters import (
+    CatalogSearchParameters,
+)
 from datacosmos.stac.item.models.datacosmos_item import DatacosmosItem
 from datacosmos.stac.item.models.item_update import ItemUpdate
 from datacosmos.stac.item.models.search_parameters import SearchParameters
@@ -59,17 +62,20 @@ class ItemClient:
 
         return self.search_items(parameters)
 
-    def search_items(self, parameters: SearchParameters) -> Generator[Item, None, None]:
+    def search_items(
+        self, parameters: CatalogSearchParameters, project_id: str
+    ) -> Generator[Item, None, None]:
         """Query the STAC catalog using the POST endpoint with filtering and pagination.
 
         Args:
-            parameters (SearchParameters): The search parameters.
+            parameters (CatalogSearchParameters): The search parameters.
 
         Yields:
             Item: Parsed STAC item.
         """
         url = self.base_url.with_suffix("/search")
-        body = parameters.model_dump(by_alias=True, exclude_none=True)
+        parameters_query = parameters.to_query()
+        body = {"project": project_id, "limit": 50, "query": parameters_query}
         return self._paginate_items(url, body)
 
     def create_item(self, collection_id: str, item: Item | DatacosmosItem) -> None:

datacosmos-0.0.4/datacosmos/stac/item/models/catalog_search_parameters.py

@@ -0,0 +1,132 @@
+"""Query parameters for catalog search."""
+
+from datetime import datetime, timedelta
+from typing import Any, List, Optional
+
+from pydantic import BaseModel, field_validator, model_validator
+
+from datacosmos.stac.constants.satellite_name_mapping import SATELLITE_NAME_MAPPING
+from datacosmos.stac.enums.processing_level import ProcessingLevel
+from datacosmos.stac.enums.product_type import ProductType
+from datacosmos.stac.enums.season import Season
+
+
+class CatalogSearchParameters(BaseModel):
+    """Query parameters for catalog search."""
+
+    start_date: Optional[str] = None
+    end_date: Optional[str] = None
+    seasons: Optional[List[Season]] = None
+    satellite: Optional[List[str]] = None
+    product_type: Optional[List[ProductType]] = None
+    processing_level: Optional[List[ProcessingLevel]] = None
+
+    # --- Field Validators ---
+
+    @field_validator("seasons", mode="before")
+    @classmethod
+    def parse_seasons(cls, value):
+        """Parses seasons values into a list of Season object."""
+        if value is None:
+            return None
+        return [Season(v) if not isinstance(v, Season) else v for v in value]
+
+    @field_validator("product_type", mode="before")
+    @classmethod
+    def parse_product_types(cls, value):
+        """Parses product types values into a list of ProductType object."""
+        if value is None:
+            return None
+        return [ProductType(v) if not isinstance(v, ProductType) else v for v in value]
+
+    @field_validator("processing_level", mode="before")
+    @classmethod
+    def parse_processing_levels(cls, value):
+        """Parses processing levels values into a list of ProcessingLevel object."""
+        if value is None:
+            return None
+        return [
+            ProcessingLevel(v) if not isinstance(v, ProcessingLevel) else v
+            for v in value
+        ]
+
+    @field_validator("start_date", mode="before")
+    @classmethod
+    def parse_start_date(cls, value: Any) -> Optional[str]:
+        """Validations on start_date."""
+        if value is None:
+            return None
+        try:
+            dt = datetime.strptime(value, "%m/%d/%Y")
+            if dt < datetime(2015, 5, 15):
+                raise ValueError("Date must be 5/15/2015 or later.")
+            return dt.isoformat() + "Z"
+        except ValueError:
+            raise ValueError(
+                "Invalid start_date format. Use mm/dd/yyyy (e.g., 05/15/2024)"
+            )
+
+    @field_validator("end_date", mode="before")
+    @classmethod
+    def parse_end_date(cls, value: Any) -> Optional[str]:
+        """Validations on end_date."""
+        if value is None:
+            return None
+        try:
+            dt = datetime.strptime(value, "%m/%d/%Y")
+            if dt < datetime(2015, 5, 15):
+                raise ValueError("Date must be 5/15/2015 or later.")
+            dt = dt + timedelta(days=1) - timedelta(milliseconds=1)
+            return dt.isoformat() + "Z"
+        except ValueError:
+            raise ValueError(
+                "Invalid end_date format. Use mm/dd/yyyy (e.g., 05/15/2024)"
+            )
+
+    # --- Model Validator ---
+
+    @model_validator(mode="after")
+    def validate_date_range(self) -> "CatalogSearchParameters":
+        """Checks if end_date is after the start_date."""
+        if self.start_date and self.end_date:
+            start_dt = datetime.fromisoformat(self.start_date.rstrip("Z"))
+            end_dt = datetime.fromisoformat(self.end_date.rstrip("Z"))
+            if start_dt > end_dt:
+                raise ValueError("end_date cannot be before start_date.")
+        return self
+
+    # --- Query Mapper ---
+
+    def to_query(self) -> dict:
+        """Map user-friendly input to STAC query structure."""
+        query = {}
+
+        if self.start_date or self.end_date:
+            query["datetime"] = {"gte": self.start_date, "lte": self.end_date}
+
+        if self.seasons:
+            query["opencosmos:season"] = {
+                "in": [seasons.value for seasons in self.seasons]
+            }
+
+        if self.product_type:
+            query["opencosmos:product_type"] = {
+                "in": [product_type.value for product_type in self.product_type]
+            }
+
+        if self.processing_level:
+            query["processing:level"] = {
+                "in": [
+                    processing_level.value for processing_level in self.processing_level
+                ]
+            }
+
+        if self.satellite:
+            cospars = [
+                SATELLITE_NAME_MAPPING[ui]
+                for ui in self.satellite
+                if ui in SATELLITE_NAME_MAPPING
+            ]
+            query["sat:platform_international_designator"] = {"in": cospars}
+
+        return query

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos/stac/item/models/datacosmos_item.py

@@ -4,7 +4,7 @@ from datetime import datetime
 
 from pydantic import BaseModel
 
-from datacosmos.stac.enums.level import Level
+from datacosmos.stac.enums.processing_level import ProcessingLevel
 from datacosmos.stac.item.models.asset import Asset
 
 
@@ -36,9 +36,9 @@ class DatacosmosItem(BaseModel):
         return datetime.strptime(self.properties["datetime"], "%Y-%m-%dT%H:%M:%SZ")
 
     @property
-    def level(self) -> Level:
+    def level(self) -> ProcessingLevel:
         """Get the processing level of the Datacosmos item."""
-        return Level(self.properties["processing:level"].lower())
+        return ProcessingLevel(self.properties["processing:level"].lower())
 
     @property
     def sat_int_designator(self) -> str:

{datacosmos-0.0.3 → datacosmos-0.0.4/datacosmos.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datacosmos
-Version: 0.0.3
+Version: 0.0.4
 Summary: A library for interacting with DataCosmos from Python code
 Author-email: Open Cosmos <support@open-cosmos.com>
 Classifier: Programming Language :: Python :: 3
@@ -13,6 +13,7 @@ Requires-Dist: oauthlib==3.2.0
 Requires-Dist: requests-oauthlib==1.3.1
 Requires-Dist: pydantic==2.10.6
 Requires-Dist: pystac==1.12.1
+Requires-Dist: pyyaml==6.0.2
 Provides-Extra: dev
 Requires-Dist: black==22.3.0; extra == "dev"
 Requires-Dist: ruff==0.9.5; extra == "dev"

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos.egg-info/SOURCES.txt

@@ -21,12 +21,17 @@ datacosmos/stac/collection/__init__.py
 datacosmos/stac/collection/collection_client.py
 datacosmos/stac/collection/models/__init__.py
 datacosmos/stac/collection/models/collection_update.py
+datacosmos/stac/constants/__init__.py
+datacosmos/stac/constants/satellite_name_mapping.py
 datacosmos/stac/enums/__init__.py
-datacosmos/stac/enums/level.py
+datacosmos/stac/enums/processing_level.py
+datacosmos/stac/enums/product_type.py
+datacosmos/stac/enums/season.py
 datacosmos/stac/item/__init__.py
 datacosmos/stac/item/item_client.py
 datacosmos/stac/item/models/__init__.py
 datacosmos/stac/item/models/asset.py
+datacosmos/stac/item/models/catalog_search_parameters.py
 datacosmos/stac/item/models/datacosmos_item.py
 datacosmos/stac/item/models/eo_band.py
 datacosmos/stac/item/models/item_update.py

{datacosmos-0.0.3 → datacosmos-0.0.4}/datacosmos.egg-info/requires.txt

@@ -4,6 +4,7 @@ oauthlib==3.2.0
 requests-oauthlib==1.3.1
 pydantic==2.10.6
 pystac==1.12.1
+pyyaml==6.0.2
 
 [dev]
 black==22.3.0

{datacosmos-0.0.3 → datacosmos-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "datacosmos"
-version = "0.0.3"
+version = "0.0.4"
 authors = [
     { name="Open Cosmos", email="support@open-cosmos.com" },
 ]
@@ -20,7 +20,8 @@ dependencies = [
     "oauthlib==3.2.0",
     "requests-oauthlib==1.3.1",
     "pydantic==2.10.6",
-    "pystac==1.12.1"
+    "pystac==1.12.1",
+    "pyyaml==6.0.2"
 ]
 
 [project.optional-dependencies]

datacosmos-0.0.3/datacosmos/stac/enums/level.py

@@ -1,15 +0,0 @@
-"""Level enum class."""
-
-from enum import Enum
-
-
-class Level(Enum):
-    """Enum class for the processing levels of the data."""
-
-    L0 = "l0"
-    L1A = "l1a"
-    L2A = "l2a"
-    L1B = "l1b"
-    L1C = "l1c"
-    L1D = "l1d"
-    L3 = "l3"