datacosmos 0.0.1__tar.gz

datacosmos-0.0.1/LICENSE.md

@@ -0,0 +1,12 @@
+Copyright (c) 2022, OPEN COSMOS LTD
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

datacosmos-0.0.1/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.2
+Name: datacosmos
+Version: 0.0.1
+Summary: A library for interacting with DataCosmos from Python code
+Author-email: Open Cosmos <support@open-cosmos.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+License-File: LICENSE.md
+Requires-Dist: pydantic_settings>=2.7.0
+Requires-Dist: requests==2.31.0
+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
+Provides-Extra: dev
+Requires-Dist: black==22.3.0; extra == "dev"
+Requires-Dist: ruff==0.9.5; extra == "dev"
+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"

datacosmos-0.0.1/README.md

@@ -0,0 +1,239 @@
+# 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
+```
+
+## 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 datacosmos.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.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 pystac import Item, Asset
+from datetime import datetime
+
+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
+
+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
+```

datacosmos-0.0.1/datacosmos/__init__.py

@@ -0,0 +1 @@
+"""A library for interacting with DataCosmos from Python code."""

datacosmos-0.0.1/datacosmos/datacosmos_client.py

@@ -0,0 +1,120 @@
+"""DatacosmosClient handles authenticated interactions with the Datacosmos API.
+
+Automatically manages token refreshing and provides HTTP convenience
+methods.
+"""
+
+from datetime import datetime, timedelta, timezone
+from typing import Any, Optional
+
+import requests
+from oauthlib.oauth2 import BackendApplicationClient
+from requests.exceptions import ConnectionError, HTTPError, RequestException, Timeout
+from requests_oauthlib import OAuth2Session
+
+from config.config import Config
+from datacosmos.exceptions.datacosmos_exception import DatacosmosException
+
+
+class DatacosmosClient:
+    """Client to interact with the Datacosmos API with authentication and request handling."""
+
+    def __init__(self, config: Optional[Config] = None):
+        """Initialize the DatacosmosClient.
+
+        Args:
+            config (Optional[Config]): Configuration object.
+        """
+        if config:
+            self.config = config
+        else:
+            try:
+                self.config = Config.from_yaml()
+            except ValueError:
+                self.config = Config.from_env()
+
+        self.token = None
+        self.token_expiry = None
+        self._http_client = self._authenticate_and_initialize_client()
+
+    def _authenticate_and_initialize_client(self) -> requests.Session:
+        """Authenticate and initialize the HTTP client with a valid token."""
+        try:
+            client = BackendApplicationClient(
+                client_id=self.config.authentication.client_id
+            )
+            oauth_session = OAuth2Session(client=client)
+
+            token_response = oauth_session.fetch_token(
+                token_url=self.config.authentication.token_url,
+                client_id=self.config.authentication.client_id,
+                client_secret=self.config.authentication.client_secret,
+                audience=self.config.authentication.audience,
+            )
+
+            self.token = token_response["access_token"]
+            self.token_expiry = datetime.now(timezone.utc) + timedelta(
+                seconds=token_response.get("expires_in", 3600)
+            )
+
+            http_client = requests.Session()
+            http_client.headers.update({"Authorization": f"Bearer {self.token}"})
+            return http_client
+        except (HTTPError, ConnectionError, Timeout) as e:
+            raise DatacosmosException(f"Authentication failed: {str(e)}") from e
+        except RequestException as e:
+            raise DatacosmosException(
+                f"Unexpected request failure during authentication: {str(e)}"
+            ) from e
+
+    def _refresh_token_if_needed(self):
+        """Refresh the token if it has expired."""
+        if not self.token or self.token_expiry <= datetime.now(timezone.utc):
+            self._http_client = self._authenticate_and_initialize_client()
+
+    def request(
+        self, method: str, url: str, *args: Any, **kwargs: Any
+    ) -> requests.Response:
+        """Send an HTTP request using the authenticated session."""
+        self._refresh_token_if_needed()
+        try:
+            response = self._http_client.request(method, url, *args, **kwargs)
+            response.raise_for_status()
+            return response
+        except HTTPError as e:
+            raise DatacosmosException(
+                f"HTTP error during {method.upper()} request to {url}",
+                response=e.response,
+            ) from e
+        except ConnectionError as e:
+            raise DatacosmosException(
+                f"Connection error during {method.upper()} request to {url}: {str(e)}"
+            ) from e
+        except Timeout as e:
+            raise DatacosmosException(
+                f"Request timeout during {method.upper()} request to {url}: {str(e)}"
+            ) from e
+        except RequestException as e:
+            raise DatacosmosException(
+                f"Unexpected request failure during {method.upper()} request to {url}: {str(e)}"
+            ) from e
+
+    def get(self, url: str, *args: Any, **kwargs: Any) -> requests.Response:
+        """Send a GET request using the authenticated session."""
+        return self.request("GET", url, *args, **kwargs)
+
+    def post(self, url: str, *args: Any, **kwargs: Any) -> requests.Response:
+        """Send a POST request using the authenticated session."""
+        return self.request("POST", url, *args, **kwargs)
+
+    def put(self, url: str, *args: Any, **kwargs: Any) -> requests.Response:
+        """Send a PUT request using the authenticated session."""
+        return self.request("PUT", url, *args, **kwargs)
+
+    def patch(self, url: str, *args: Any, **kwargs: Any) -> requests.Response:
+        """Send a PATCH request using the authenticated session."""
+        return self.request("PATCH", url, *args, **kwargs)
+
+    def delete(self, url: str, *args: Any, **kwargs: Any) -> requests.Response:
+        """Send a DELETE request using the authenticated session."""
+        return self.request("DELETE", url, *args, **kwargs)

datacosmos-0.0.1/datacosmos.egg-info/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.2
+Name: datacosmos
+Version: 0.0.1
+Summary: A library for interacting with DataCosmos from Python code
+Author-email: Open Cosmos <support@open-cosmos.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+License-File: LICENSE.md
+Requires-Dist: pydantic_settings>=2.7.0
+Requires-Dist: requests==2.31.0
+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
+Provides-Extra: dev
+Requires-Dist: black==22.3.0; extra == "dev"
+Requires-Dist: ruff==0.9.5; extra == "dev"
+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"

datacosmos-0.0.1/datacosmos.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+pyproject.toml
+datacosmos/__init__.py
+datacosmos/datacosmos_client.py
+datacosmos.egg-info/PKG-INFO
+datacosmos.egg-info/SOURCES.txt
+datacosmos.egg-info/dependency_links.txt
+datacosmos.egg-info/requires.txt
+datacosmos.egg-info/top_level.txt
+tests/test_pass.py

datacosmos-0.0.1/datacosmos.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

datacosmos-0.0.1/datacosmos.egg-info/requires.txt

@@ -0,0 +1,14 @@
+pydantic_settings>=2.7.0
+requests==2.31.0
+oauthlib==3.2.0
+requests-oauthlib==1.3.1
+pydantic==2.10.6
+pystac==1.12.1
+
+[dev]
+black==22.3.0
+ruff==0.9.5
+pytest==7.2.0
+bandit[toml]==1.7.4
+isort==5.11.4
+pydocstyle==6.1.1

datacosmos-0.0.1/datacosmos.egg-info/top_level.txt

@@ -0,0 +1 @@
+datacosmos

datacosmos-0.0.1/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "datacosmos"
+version = "0.0.1"
+authors = [
+    { name="Open Cosmos", email="support@open-cosmos.com" },
+]
+description = "A library for interacting with DataCosmos from Python code"
+requires-python = ">=3.10"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+    "pydantic_settings>=2.7.0",
+    "requests==2.31.0",
+    "oauthlib==3.2.0",
+    "requests-oauthlib==1.3.1",
+    "pydantic==2.10.6",
+    "pystac==1.12.1"
+]
+
+[project.optional-dependencies]
+dev = [
+    "black==22.3.0",
+    "ruff==0.9.5",
+    "pytest==7.2.0",
+    "bandit[toml]==1.7.4",
+    "isort==5.11.4",
+    "pydocstyle==6.1.1"
+]
+
+[tool.setuptools]
+packages = ["datacosmos"]
+
+[tool.bandit]
+exclude_dirs = [".venv"]
+
+[tool.pydocstyle]
+convention = "google"
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+line_length = 88

datacosmos-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

datacosmos-0.0.1/tests/test_pass.py

@@ -0,0 +1,9 @@
+"""Test suite for basic functionality and CI setup."""
+
+
+class TestPass:
+    """A simple test class to validate the CI pipeline setup."""
+
+    def test_pass(self):
+        """A passing test to ensure the CI pipeline is functional."""
+        assert True