datacosmos 0.0.2__tar.gz → 0.0.3__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: datacosmos
-Version: 0.0.2
+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/README.md

@@ -0,0 +1,209 @@
+# DataCosmos SDK
+
+## Overview
+
+The **DataCosmos SDK** enables Open Cosmos customers to interact with the **DataCosmos APIs** for efficient data management and retrieval. It provides authentication handling, HTTP request utilities, and a client for interacting with the **STAC API** (SpatioTemporal Asset Catalog).
+
+## Installation
+
+Install the SDK using **pip**:
+
+```sh
+pip install datacosmos=={version}
+```
+
+## Initializing the Client
+
+To start using the SDK, initialize the client. The easiest way to do this is by loading the configuration from a YAML file. Alternatively, you can manually instantiate the Config object or use environment variables.
+
+### Default Initialization (Recommended)
+
+By default, the client loads configuration from a YAML file (`config/config.yaml`).
+
+```python
+from datacosmos.datacosmos_client import DatacosmosClient
+
+client = DatacosmosClient()
+```
+
+### Loading from YAML (Recommended)
+
+Create a YAML file (`config/config.yaml`) with the following content:
+
+```yaml
+authentication:
+    client_id: {client_id}  
+    client_secret: {client_secret}
+```
+
+The client will automatically read this file when initialized.
+
+### Loading from Environment Variables
+
+Set the following environment variables:
+
+```sh
+export OC_AUTH_CLIENT_ID={client_id}
+export OC_AUTH_CLIENT_SECRET={client_secret}
+```
+
+The client will automatically read these values when initialized.
+
+### Manual Instantiation
+
+If manually instantiating `Config`, default values are now applied where possible.
+
+```python
+from config.config import Config
+from config.models.m2m_authentication_config import M2MAuthenticationConfig
+from config.models.url import URL
+
+config = Config(
+    authentication=M2MAuthenticationConfig(
+        client_id="your-client-id",
+        client_secret="your-client-secret"
+    )
+)
+
+client = DatacosmosClient(config=config)
+```
+
+### Configuration Options and Defaults
+
+| Setting                      | Default Value                                     | Override Method |
+|------------------------------|-------------------------------------------------|----------------|
+| `authentication.type`        | `m2m`                                           | YAML / ENV     |
+| `authentication.client_id`   | _Required in manual instantiation_              | YAML / ENV     |
+| `authentication.client_secret` | _Required in manual instantiation_            | YAML / ENV     |
+| `stac.protocol`              | `https`                                         | YAML / ENV     |
+| `stac.host`                  | `app.open-cosmos.com`                           | YAML / ENV     |
+| `stac.port`                  | `443`                                           | YAML / ENV     |
+| `stac.path`                  | `/api/data/v0/stac`                             | YAML / ENV     |
+| `datacosmos_cloud_storage.protocol` | `https`                                 | YAML / ENV     |
+| `datacosmos_cloud_storage.host`     | `app.open-cosmos.com`                   | YAML / ENV     |
+| `datacosmos_cloud_storage.port`     | `443`                                   | YAML / ENV     |
+| `datacosmos_cloud_storage.path`     | `/api/data/v0/storage`                 | YAML / ENV     |
+| `mission_id`                | `0`                                             | YAML / ENV     |
+| `environment`               | `test`                                          | YAML / ENV     |
+
+## STAC Client
+
+The `STACClient` enables interaction with the STAC API, allowing for searching, retrieving, creating, updating, and deleting STAC items and collections.
+
+### Initialize STACClient
+
+```python
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.stac_client import STACClient
+
+client = DatacosmosClient()
+stac_client = STACClient(client)
+```
+
+### STACClient Methods
+
+#### 1. Fetch a Collection
+
+```python
+collection = stac_client.fetch_collection("test-collection")
+```
+
+#### 2. Fetch All Collections
+
+```python
+collections = list(stac_client.fetch_all_collections())
+```
+
+#### 3. Create a Collection
+
+```python
+from pystac import Collection
+
+new_collection = Collection(
+    id="test-collection",
+    title="Test Collection",
+    description="This is a test collection",
+    license="proprietary",
+    extent={
+        "spatial": {"bbox": [[-180, -90, 180, 90]]},
+        "temporal": {"interval": [["2023-01-01T00:00:00Z", None]]},
+    },
+)
+
+stac_client.create_collection(new_collection)
+```
+
+#### 4. Update a Collection
+
+```python
+from datacosmos.stac.collection.models.collection_update import CollectionUpdate
+
+update_data = CollectionUpdate(
+    title="Updated Collection Title",
+    description="Updated description",
+)
+
+stac_client.update_collection("test-collection", update_data)
+```
+
+#### 5. Delete a Collection
+
+```python
+stac_client.delete_collection("test-collection")
+```
+
+### Uploading Files and Registering STAC Items
+
+You can use the `DatacosmosUploader` class to upload files to the DataCosmos cloud storage and register a STAC item.
+
+#### Upload Files and Register STAC Item
+
+```python
+from datacosmos.uploader.datacosmos_uploader import DatacosmosUploader
+
+uploader = DatacosmosUploader(client)
+item_json_file_path = "/path/to/stac_item.json"
+uploader.upload_and_register_item(item_json_file_path)
+```
+
+## Error Handling
+
+Use `try-except` blocks to handle API errors gracefully:
+
+```python
+try:
+    data = client.get_data("dataset_id")
+    print(data)
+except Exception as e:
+    print(f"An error occurred: {e}")
+```
+
+## Contributing
+
+To contribute:
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Submit a pull request.
+
+### Development Setup
+
+Use `uv` for dependency management:
+
+```sh
+pip install uv
+uv venv
+uv pip install -r pyproject.toml .[dev]
+source .venv/bin/activate
+```
+
+Before making changes, run:
+
+```sh
+black .
+isort .
+ruff check .
+pydocstyle .
+bandit -r -c pyproject.toml .
+pytest
+```

{datacosmos-0.0.2 → datacosmos-0.0.3}/config/config.py

@@ -6,7 +6,7 @@ and supports environment variable-based overrides.
 """
 
 import os
-from typing import ClassVar, Optional
+from typing import ClassVar, Literal, Optional
 
 import yaml
 from pydantic import field_validator
@@ -27,6 +27,9 @@ class Config(BaseSettings):
 
     authentication: Optional[M2MAuthenticationConfig] = None
     stac: Optional[URL] = None
+    datacosmos_cloud_storage: Optional[URL] = None
+    mission_id: int = 0
+    environment: Literal["local", "test", "prod"] = "test"
 
     DEFAULT_AUTH_TYPE: ClassVar[str] = "m2m"
     DEFAULT_AUTH_TOKEN_URL: ClassVar[str] = "https://login.open-cosmos.com/oauth/token"
@@ -77,7 +80,20 @@ class Config(BaseSettings):
             path=os.getenv("OC_STAC_PATH", "/api/data/v0/stac"),
         )
 
-        return cls(authentication=authentication_config, stac=stac_config)
+        datacosmos_cloud_storage_config = URL(
+            protocol=os.getenv("DC_CLOUD_STORAGE_PROTOCOL", "https"),
+            host=os.getenv("DC_CLOUD_STORAGE_HOST", "app.open-cosmos.com"),
+            port=int(os.getenv("DC_CLOUD_STORAGE_PORT", "443")),
+            path=os.getenv("DC_CLOUD_STORAGE_PATH", "/api/data/v0/storage"),
+        )
+
+        return cls(
+            authentication=authentication_config,
+            stac=stac_config,
+            datacosmos_cloud_storage=datacosmos_cloud_storage_config,
+            mission_id=int(os.getenv("MISSION_ID", "0")),
+            environment=os.getenv("ENVIRONMENT", "test"),
+        )
 
     @field_validator("authentication", mode="before")
     @classmethod
@@ -96,7 +112,7 @@ class Config(BaseSettings):
             ValueError: If authentication is missing or required fields are not set.
         """
         if not auth_data:
-            cls.raise_missing_auth_error()
+            return cls.apply_auth_defaults(M2MAuthenticationConfig())
 
         auth = cls.parse_auth_config(auth_data)
         auth = cls.apply_auth_defaults(auth)
@@ -105,34 +121,24 @@ class Config(BaseSettings):
         return auth
 
     @staticmethod
-    def raise_missing_auth_error():
-        """Raise an error when authentication is missing."""
-        raise ValueError(
-            "M2M authentication is required. Provide it via:\n"
-            "1. Explicit instantiation (Config(authentication=...))\n"
-            "2. A YAML config file (config.yaml)\n"
-            "3. Environment variables (OC_AUTH_CLIENT_ID, OC_AUTH_CLIENT_SECRET, etc.)"
-        )
-
-    @staticmethod
-    def parse_auth_config(auth_data: dict) -> M2MAuthenticationConfig:
-        """Convert dictionary input to M2MAuthenticationConfig object."""
-        return (
-            M2MAuthenticationConfig(**auth_data)
-            if isinstance(auth_data, dict)
-            else auth_data
-        )
-
-    @classmethod
-    def apply_auth_defaults(
-        cls, auth: M2MAuthenticationConfig
-    ) -> M2MAuthenticationConfig:
+    def apply_auth_defaults(auth: M2MAuthenticationConfig) -> M2MAuthenticationConfig:
         """Apply default authentication values if they are missing."""
-        auth.type = auth.type or cls.DEFAULT_AUTH_TYPE
-        auth.token_url = auth.token_url or cls.DEFAULT_AUTH_TOKEN_URL
-        auth.audience = auth.audience or cls.DEFAULT_AUTH_AUDIENCE
+        auth.type = auth.type or Config.DEFAULT_AUTH_TYPE
+        auth.token_url = auth.token_url or Config.DEFAULT_AUTH_TOKEN_URL
+        auth.audience = auth.audience or Config.DEFAULT_AUTH_AUDIENCE
         return auth
 
+    @classmethod
+    def parse_auth_config(cls, auth_data: dict) -> M2MAuthenticationConfig:
+        """Parse authentication config from a dictionary."""
+        return M2MAuthenticationConfig(
+            type=auth_data.get("type", cls.DEFAULT_AUTH_TYPE),
+            token_url=auth_data.get("token_url", cls.DEFAULT_AUTH_TOKEN_URL),
+            audience=auth_data.get("audience", cls.DEFAULT_AUTH_AUDIENCE),
+            client_id=auth_data.get("client_id"),
+            client_secret=auth_data.get("client_secret"),
+        )
+
     @staticmethod
     def check_required_auth_fields(auth: M2MAuthenticationConfig):
         """Ensure required fields (client_id, client_secret) are provided."""
@@ -165,3 +171,25 @@ class Config(BaseSettings):
                 path="/api/data/v0/stac",
             )
         return stac_config
+
+    @field_validator("datacosmos_cloud_storage", mode="before")
+    @classmethod
+    def validate_datacosmos_cloud_storage(
+        cls, datacosmos_cloud_storage_config: Optional[URL]
+    ) -> URL:
+        """Ensure datacosmos cloud storage configuration has a default if not explicitly set.
+
+        Args:
+            datacosmos_cloud_storage_config (Optional[URL]): The datacosmos cloud storage config to validate.
+
+        Returns:
+            URL: The validated datacosmos cloud storage configuration.
+        """
+        if datacosmos_cloud_storage_config is None:
+            return URL(
+                protocol="https",
+                host="app.open-cosmos.com",
+                port=443,
+                path="/api/data/v0/storage",
+            )
+        return datacosmos_cloud_storage_config

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

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

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

@@ -0,0 +1,15 @@
+"""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"

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

@@ -9,6 +9,7 @@ from pystac import Item
 
 from datacosmos.datacosmos_client import DatacosmosClient
 from datacosmos.exceptions.datacosmos_exception import DatacosmosException
+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
 from datacosmos.utils.http_response.check_api_response import check_api_response
@@ -71,7 +72,7 @@ class ItemClient:
         body = parameters.model_dump(by_alias=True, exclude_none=True)
         return self._paginate_items(url, body)
 
-    def create_item(self, collection_id: str, item: Item) -> None:
+    def create_item(self, collection_id: str, item: Item | DatacosmosItem) -> None:
         """Create a new STAC item in a specified collection.
 
         Args:

datacosmos-0.0.3/datacosmos/stac/item/models/asset.py

@@ -0,0 +1,23 @@
+"""Model representing a datacosmos item asset."""
+
+from pydantic import BaseModel, Field
+
+from datacosmos.stac.item.models.eo_band import EoBand
+from datacosmos.stac.item.models.raster_band import RasterBand
+
+
+class Asset(BaseModel):
+    """Model representing a datacosmos item asset."""
+
+    href: str
+    title: str
+    description: str
+    type: str
+    roles: list[str] | None
+    eo_bands: list[EoBand] | None = Field(default=None, alias="eo:bands")
+    raster_bands: list[RasterBand] | None = Field(default=None, alias="raster:bands")
+
+    class Config:
+        """Pydantic configuration."""
+
+        populate_by_name = True

datacosmos-0.0.3/datacosmos/stac/item/models/datacosmos_item.py

@@ -0,0 +1,55 @@
+"""Model representing a datacosmos item."""
+
+from datetime import datetime
+
+from pydantic import BaseModel
+
+from datacosmos.stac.enums.level import Level
+from datacosmos.stac.item.models.asset import Asset
+
+
+class DatacosmosItem(BaseModel):
+    """Model representing a datacosmos item."""
+
+    id: str
+    type: str
+    stac_version: str
+    stac_extensions: list | None
+    geometry: dict
+    properties: dict
+    links: list
+    assets: dict[str, Asset]
+    collection: str
+    bbox: tuple[float, float, float, float]
+
+    def get_property(self, key: str) -> str | None:
+        """Get a property value from the Datacosmos item."""
+        return self.properties.get(key)
+
+    def get_asset(self, key: str) -> Asset | None:
+        """Get an asset from the Datacosmos item."""
+        return self.assets.get(key)
+
+    @property
+    def datetime(self) -> datetime:
+        """Get the datetime of the Datacosmos item."""
+        return datetime.strptime(self.properties["datetime"], "%Y-%m-%dT%H:%M:%SZ")
+
+    @property
+    def level(self) -> Level:
+        """Get the processing level of the Datacosmos item."""
+        return Level(self.properties["processing:level"].lower())
+
+    @property
+    def sat_int_designator(self) -> str:
+        """Get the satellite international designator of the Datacosmos item."""
+        property = self.get_property("sat:platform_international_designator")
+        if property is None:
+            raise ValueError(
+                "sat:platform_international_designator is missing in STAC item"
+            )
+        return property
+
+    def to_dict(self) -> dict:
+        """Converts the DatacosmosItem instance to a dictionary."""
+        return self.model_dump()

datacosmos-0.0.3/datacosmos/stac/item/models/eo_band.py

@@ -0,0 +1,15 @@
+"""Model representing an EO band."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class EoBand(BaseModel):
+    """Model representing an EO band."""
+
+    name: str
+    common_name: str
+    center_wavelength: float
+    full_width_half_max: float
+    solar_illumination: Optional[float] = None

datacosmos-0.0.3/datacosmos/stac/item/models/raster_band.py

@@ -0,0 +1,17 @@
+"""Model representing a raster band."""
+
+from pydantic import BaseModel, Field
+
+
+class RasterBand(BaseModel):
+    """Model representing a raster band."""
+
+    gain: float = Field(alias="scale")
+    bias: float = Field(alias="offset")
+    nodata: int
+    unit: str
+
+    class Config:
+        """Pydantic configuration."""
+
+        populate_by_name = True

datacosmos-0.0.3/datacosmos/uploader/__init__.py

@@ -0,0 +1 @@
+"""Uploader package for interacting with the Uploader API, providing upload functionalities to the datacosmos cloud storage."""

datacosmos-0.0.3/datacosmos/uploader/dataclasses/__init__.py

@@ -0,0 +1 @@
+"""Dataclasses for the uploader module."""

datacosmos-0.0.3/datacosmos/uploader/dataclasses/upload_path.py

@@ -0,0 +1,93 @@
+"""Dataclass for retrieving the upload path of a file."""
+
+from dataclasses import dataclass
+from datetime import datetime
+from pathlib import Path
+
+import structlog
+
+from datacosmos.stac.enums.level import Level
+from datacosmos.stac.item.models.datacosmos_item import DatacosmosItem
+from datacosmos.utils.missions import get_mission_id
+
+logger = structlog.get_logger()
+
+
+@dataclass
+class UploadPath:
+    """Dataclass for retrieving the upload path of a file."""
+
+    mission: str
+    level: Level
+    day: int
+    month: int
+    year: int
+    id: str
+    path: str
+
+    def __str__(self):
+        """Return a human-readable string representation of the Path."""
+        path = f"full/{self.mission.lower()}/{self.level.value.lower()}/{self.year:02}/{self.month:02}/{self.day:02}/{self.id}/{self.path}"
+        return path.removesuffix("/")
+
+    @classmethod
+    def from_item_path(
+        cls, item: DatacosmosItem, mission: str, item_path: str
+    ) -> "Path":
+        """Create a Path instance from a DatacosmosItem and a path."""
+        for asset in item.assets.values():
+            if mission == "":
+                mission = cls._get_mission_name(asset.href)
+            else:
+                break
+        dt = datetime.strptime(item.properties["datetime"], "%Y-%m-%dT%H:%M:%SZ")
+        path = UploadPath(
+            mission=mission,
+            level=Level(item.properties["processing:level"].lower()),
+            day=dt.day,
+            month=dt.month,
+            year=dt.year,
+            id=item.id,
+            path=item_path,
+        )
+        return cls(**path.__dict__)
+
+    @classmethod
+    def from_path(cls, path: str) -> "Path":
+        """Create a Path instance from a string path."""
+        parts = path.split("/")
+        if len(parts) < 7:
+            raise ValueError(f"Invalid path {path}")
+        return cls(
+            mission=parts[0],
+            level=Level(parts[1]),
+            day=int(parts[4]),
+            month=int(parts[3]),
+            year=int(parts[2]),
+            id=parts[5],
+            path="/".join(parts[6:]),
+        )
+
+    @classmethod
+    def _get_mission_name(cls, href: str) -> str:
+        mission = ""
+        # bruteforce mission name from asset path
+        # traverse the path and check if any part is a mission name (generates a mission id)
+        href_parts = href.split("/")
+        for idx, part in enumerate(href_parts):
+            try:
+                # when an id is found, then the mission name is valid
+                get_mission_id(
+                    part, "test"
+                )  # using test as it is more wide and anything on prod should exists on test
+            except KeyError:
+                continue
+            # validate the mission name by checking if the path is correct
+            # using the same logic as the __str__ method
+            mission = part.lower()
+            h = "/".join(["full", *href_parts[idx:]])
+            p = UploadPath.from_path("/".join([mission, *href_parts[idx + 1 :]]))
+            if str(p) != h:
+                raise ValueError(f"Could not find mission name in asset path {href}")
+            break
+        return mission

datacosmos-0.0.3/datacosmos/uploader/datacosmos_uploader.py

@@ -0,0 +1,106 @@
+"""Module for uploading files to Datacosmos cloud storage and registering STAC items."""
+
+from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
+
+from pydantic import TypeAdapter
+
+from datacosmos.datacosmos_client import DatacosmosClient
+from datacosmos.stac.item.item_client import ItemClient
+from datacosmos.stac.item.models.datacosmos_item import DatacosmosItem
+from datacosmos.uploader.dataclasses.upload_path import UploadPath
+from datacosmos.utils.missions import get_mission_name
+
+
+class DatacosmosUploader:
+    """Handles uploading files to Datacosmos storage and registering STAC items."""
+
+    def __init__(self, client: DatacosmosClient):
+        """Initialize the uploader with DatacosmosClient."""
+        mission_id = client.config.mission_id
+        environment = client.config.environment
+
+        self.datacosmos_client = client
+        self.item_client = ItemClient(client)
+        self.mission_name = (
+            get_mission_name(mission_id, environment) if mission_id != 0 else ""
+        )
+        self.base_url = client.config.datacosmos_cloud_storage.as_domain_url()
+
+    def upload_and_register_item(self, item_json_file_path: str) -> None:
+        """Uploads files to Datacosmos storage and registers a STAC item.
+
+        Args:
+            item_json_file_path (str): Path to the STAC item JSON file.
+        """
+        item = self._load_item(item_json_file_path)
+        collection_id, item_id = item.collection, item.id
+        dirname = str(Path(item_json_file_path).parent / Path(item_json_file_path).stem)
+
+        self._delete_existing_item(collection_id, item_id)
+        upload_path = self._get_upload_path(item)
+        self.upload_from_folder(dirname, upload_path)
+
+        self._update_item_assets(item)
+
+        self.item_client.create_item(collection_id, item)
+
+    def upload_file(self, src: str, dst: str) -> None:
+        """Uploads a single file to the specified destination path."""
+        url = self.base_url.with_suffix(str(dst))
+
+        with open(src, "rb") as f:
+            response = self.datacosmos_client.put(url, data=f)
+        response.raise_for_status()
+
+    def upload_from_folder(self, src: str, dst: UploadPath, workers: int = 4) -> None:
+        """Uploads all files from a folder to the destination path in parallel."""
+        if Path(dst.path).is_file():
+            raise ValueError(f"Destination path should not be a file path {dst}")
+
+        if Path(src).is_file():
+            raise ValueError(f"Source path should not be a file path {src}")
+
+        with ThreadPoolExecutor(max_workers=workers) as executor:
+            futures = []
+            for file in Path(src).rglob("*"):
+                if file.is_file():
+                    dst = UploadPath(
+                        mission=dst.mission,
+                        level=dst.level,
+                        day=dst.day,
+                        month=dst.month,
+                        year=dst.year,
+                        id=dst.id,
+                        path=str(file.relative_to(src)),
+                    )
+                    futures.append(executor.submit(self.upload_file, str(file), dst))
+            for future in futures:
+                future.result()
+
+    @staticmethod
+    def _load_item(item_json_file_path: str) -> DatacosmosItem:
+        """Loads and validates the STAC item from a JSON file."""
+        with open(item_json_file_path, "rb") as file:
+            data = file.read().decode("utf-8")
+        return TypeAdapter(DatacosmosItem).validate_json(data)
+
+    def _delete_existing_item(self, collection_id: str, item_id: str) -> None:
+        """Deletes an existing item if it already exists."""
+        try:
+            self.item_client.delete_item(item_id, collection_id)
+        except Exception:  # nosec
+            pass  # Ignore if item doesn't exist
+
+    def _get_upload_path(self, item: DatacosmosItem) -> str:
+        """Constructs the storage upload path based on the item and mission name."""
+        return UploadPath.from_item_path(item, self.mission_name, "")
+
+    def _update_item_assets(self, item: DatacosmosItem) -> None:
+        """Updates the item's assets with uploaded file URLs."""
+        for asset in item.assets.values():
+            try:
+                url = self.base_url
+                asset.href = url.with_base(asset.href)  # type: ignore
+            except ValueError:
+                pass

datacosmos-0.0.3/datacosmos/utils/constants.py

@@ -0,0 +1,16 @@
+"""Package for storing constants."""
+
+TEST_MISSION_NAMES = {
+    55: "MENUT",
+    56: "PHISAT-2",
+    57: "HAMMER",
+    63: "MANTIS",
+    64: "PLATERO",
+}
+PROD_MISSION_NAMES = {
+    23: "MENUT",
+    29: "MANTIS",
+    35: "PHISAT-2",
+    37: "PLATERO",
+    48: "HAMMER",
+}

datacosmos-0.0.3/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-0.0.2 → datacosmos-0.0.3}/datacosmos/utils/url.py

@@ -35,3 +35,26 @@ class URL:
         """
         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.2 → datacosmos-0.0.3/datacosmos.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: datacosmos
-Version: 0.0.2
+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.2 → datacosmos-0.0.3}/datacosmos.egg-info/SOURCES.txt

@@ -21,12 +21,24 @@ 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/enums/__init__.py
+datacosmos/stac/enums/level.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/datacosmos_item.py
+datacosmos/stac/item/models/eo_band.py
 datacosmos/stac/item/models/item_update.py
+datacosmos/stac/item/models/raster_band.py
 datacosmos/stac/item/models/search_parameters.py
+datacosmos/uploader/__init__.py
+datacosmos/uploader/datacosmos_uploader.py
+datacosmos/uploader/dataclasses/__init__.py
+datacosmos/uploader/dataclasses/upload_path.py
 datacosmos/utils/__init__.py
+datacosmos/utils/constants.py
+datacosmos/utils/missions.py
 datacosmos/utils/url.py
 datacosmos/utils/http_response/__init__.py
 datacosmos/utils/http_response/check_api_response.py

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "datacosmos"
-version = "0.0.2"
+version = "0.0.3"
 authors = [
     { name="Open Cosmos", email="support@open-cosmos.com" },
 ]

datacosmos-0.0.2/README.md

@@ -1,257 +0,0 @@
-# DataCosmos SDK
-
-## Overview
-
-The **DataCosmos SDK** allows Open Cosmos' customers to interact with the **DataCosmos APIs** for seamless data management and retrieval. It provides authentication handling, HTTP request utilities, and a client for interacting with the **STAC API** (SpatioTemporal Asset Catalog).
-
-## Installation
-
-### Install via PyPI
-
-The easiest way to install the SDK is via **pip**:
-
-```sh
-pip install datacosmos=={version}
-```
-
-## Getting Started
-
-### Initializing the Client
-
-The recommended way to initialize the SDK is by passing a `Config` object with authentication credentials:
-
-```python
-from datacosmos.datacosmos_client import DatacosmosClient
-from config.config import Config
-
-config = Config(
-    authentication={
-        "client_id": "your_client_id",
-        "client_secret": "your_client_secret",
-        "token_url": "https://login.open-cosmos.com/oauth/token",
-        "audience": "https://beeapp.open-cosmos.com"
-    }
-)
-client = DatacosmosClient(config=config)
-```
-
-Alternatively, the SDK can load configuration automatically from:
-
-- A YAML file (`config/config.yaml`)
-- Environment variables
-
-### STAC Client
-
-The STACClient enables interaction with the STAC API, allowing for searching, retrieving, creating, updating, and deleting STAC items and collections.
-
-#### Initialize STACClient
-
-```python
-from datacosmos.stac.stac_client import STACClient
-
-stac_client = STACClient(client)
-```
-
-### STACClient Methods
-
-#### 1. **Fetch a Collection**
-
-```python
-from datacosmos.stac.stac_client import STACClient
-from datacosmos.datacosmos_client import DatacosmosClient
-
-datacosmos_client = DatacosmosClient()
-stac_client = STACClient(datacosmos_client)
-
-collection = stac_client.fetch_collection("test-collection")
-```
-
-#### 2. **Fetch All Collections**
-
-```python
-collections = list(stac_client.fetch_all_collections())
-```
-
-#### 3. **Create a Collection**
-
-```python
-from pystac import Collection
-
-new_collection = Collection(
-    id="test-collection",
-    title="Test Collection",
-    description="This is a test collection",
-    license="proprietary",
-    extent={
-        "spatial": {"bbox": [[-180, -90, 180, 90]]},
-        "temporal": {"interval": [["2023-01-01T00:00:00Z", None]]},
-    },
-)
-
-stac_client.create_collection(new_collection)
-```
-
-#### 4. **Update a Collection**
-
-```python
-from datacosmos.stac.collection.models.collection_update import CollectionUpdate
-
-update_data = CollectionUpdate(
-    title="Updated Collection Title version 2",
-    description="Updated description version 2",
-)
-
-stac_client.update_collection("test-collection", update_data)
-```
-
-#### 5. **Delete a Collection**
-
-```python
-collection_id = "test-collection"
-stac_client.delete_collection(collection_id)
-```
-
-#### 1. **Search Items**
-
-```python
-from datacosmos.stac.item.models.search_parameters import SearchParameters
-
-parameters = SearchParameters(collections=["example-collection"], limit=1)
-items = list(stac_client.search_items(parameters=parameters))
-```
-
-#### 2. **Fetch a Single Item**
-
-```python
-item = stac_client.fetch_item(item_id="example-item", collection_id="example-collection")
-```
-
-#### 3. **Fetch All Items in a Collection**
-
-```python
-items = stac_client.fetch_collection_items(collection_id="example-collection")
-```
-
-#### 4. **Create a New STAC Item**
-
-```python
-from datetime import datetime
-from pystac import Item, Asset
-from pystac.utils import str_to_datetime
-
-stac_item = Item(
-    id="MENUT_000001418_20240211120920_20240211120932_new_release.tiff",
-    geometry={
-        "type": "Polygon",
-        "coordinates": [
-            [
-                [-24.937406454761664, 64.5931773445667],
-                [-19.6596824245997, 64.5931773445667],
-                [-19.6596824245997, 63.117895100111724],
-                [-24.937406454761664, 63.117895100111724],
-                [-24.937406454761664, 64.5931773445667]
-            ]
-        ]
-    },
-    bbox=[
-        -24.937406454761664,
-        63.117895100111724,
-        -19.6596824245997,
-        64.5931773445667
-    ],
-    datetime=str_to_datetime("2024-02-11T12:09:32Z"),
-    properties={"processing:level": "L0"},
-    collection="menut-l0",
-)
-
-stac_item.add_asset(
-    "thumbnail",
-    Asset(
-        href="https://test.app.open-cosmos.com/api/data/v0/storage/full/menut/l0/2024/02/11/MENUT_000001418_20240211120920_20240211120932.tiff/thumbnail.webp",
-        media_type="image/webp",
-        roles=["thumbnail"],
-        title="Thumbnail",
-        description="Thumbnail of the image"
-    )
-)
-
-stac_client.create_item(collection_id="menutl-l0", item=stac_item)
-```
-
-#### 5. **Update an Existing STAC Item**
-
-```python
-from datacosmos.stac.item.models.item_update import ItemUpdate
-from pystac import Asset, Link
-
-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
-stac_client.delete_item(item_id="new-item", collection_id="example-collection")
-```
-
-## Configuration Options
-
-- **Recommended:** Instantiate `DatacosmosClient` with a `Config` object.
-- Alternatively, use **YAML files** (`config/config.yaml`).
-- Or, use **environment variables**.
-
-## Contributing
-
-If you would like to contribute:
-
-1. Fork the repository.
-2. Create a feature branch.
-3. Submit a pull request.
-
-### Development Setup
-
-If you are developing the SDK, you can use `uv` for dependency management:
-
-```sh
-pip install uv
-uv venv
-uv pip install -r pyproject.toml
-uv pip install -r pyproject.toml .[dev]
-source .venv/bin/activate
-```
-
-Before making changes, ensure that:
-
-- The code is formatted using **Black** and **isort**.
-- Static analysis and linting are performed using **ruff** and **pydocstyle**.
-- Security checks are performed using **bandit**.
-- Tests are executed with **pytest**.
-
-```sh
-black .
-isort .
-ruff check . --select C901
-pydocstyle .
-bandit -r -c pyproject.toml . --skip B105,B106,B101
-pytest
-```