cecil 0.0.14__tar.gz → 0.0.16__tar.gz

cecil-0.0.16/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.tf]
+indent_size = 2
+
+[{*.go,Makefile}]
+indent_style = tab

cecil-0.0.16/.gitignore

@@ -0,0 +1,11 @@
+__pycache__
+.coverage
+.DS_Store
+.idea
+.terraform
+.vscode
+*.log
+*.tfstate*
+dist
+tmp
+venv

cecil-0.0.16/Makefile

@@ -0,0 +1,26 @@
+HL = @printf "\033[36m>> $1\033[0m\n"
+
+.PHONY: build
+build:
+	$(call HL,build)
+	@hatch build
+
+.PHONY: clean
+clean:
+	$(call HL,clean)
+	@hatch clean
+
+.PHONY: publish.prod
+publish.prod: clean build
+	$(call HL,publish.prod)
+	@twine upload --repository pypi dist/*
+
+.PHONY: publish.test
+publish.test: clean build
+	$(call HL,publish.test)
+	@twine upload --repository testpypi dist/*
+
+.PHONY: test
+test:
+	$(call HL,test)
+	@hatch test -v

{cecil-0.0.14 → cecil-0.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: cecil
-Version: 0.0.14
+Version: 0.0.16
 Summary: Python SDK for Cecil Earth
 License-Expression: MIT
 License-File: LICENSE.txt
@@ -71,30 +71,30 @@ my_data_request = client.create_data_request(
     dataset_id=planet_forest_carbon_diligence_id,
 )
 
-print(client.get_data_request(my_data_request.id).status)
+print(client.get_data_request(my_data_request.id))
 ```
 
-### Create a reprojection using the Cecil client (once data request is completed)
+### Create a transformation using the Cecil client
 
 ```python
-my_reprojection = client.create_reprojection(
+my_transformation = client.create_transformation(
     data_request_id=my_data_request.id,
     crs="EPSG:4326",
-    resolution=0.005,
+    spatial_resolution=0.005,
 )
 
-print(client.get_reprojection(my_reprojection.id).status)
+print(client.get_transformation(my_transformation.id))
 ```
 
-### Query data (once reprojection is completed)
+### Query data (once transformation is completed)
 
 ```python
 df = client.query(f'''
     SELECT *
-    FROM 
+    FROM
         planet.forest_carbon_diligence
     WHERE
-        reprojection_id = '{my_reprojection.id}'
+        transformation_id = '{my_transformation.id}'
 ''')
 ```
 
@@ -109,9 +109,9 @@ client.list_data_requests()
 
 client.get_data_request(my_data_request.id)
 
-client.list_reprojections()
+client.list_transformations()
 
-client.get_reprojection(my_reprojection.id)
+client.get_transformation(my_transformation.id)
 ```
 
 ## License

{cecil-0.0.14 → cecil-0.0.16}/README.md

@@ -55,30 +55,30 @@ my_data_request = client.create_data_request(
     dataset_id=planet_forest_carbon_diligence_id,
 )
 
-print(client.get_data_request(my_data_request.id).status)
+print(client.get_data_request(my_data_request.id))
 ```
 
-### Create a reprojection using the Cecil client (once data request is completed)
+### Create a transformation using the Cecil client
 
 ```python
-my_reprojection = client.create_reprojection(
+my_transformation = client.create_transformation(
     data_request_id=my_data_request.id,
     crs="EPSG:4326",
-    resolution=0.005,
+    spatial_resolution=0.005,
 )
 
-print(client.get_reprojection(my_reprojection.id).status)
+print(client.get_transformation(my_transformation.id))
 ```
 
-### Query data (once reprojection is completed)
+### Query data (once transformation is completed)
 
 ```python
 df = client.query(f'''
     SELECT *
-    FROM 
+    FROM
         planet.forest_carbon_diligence
     WHERE
-        reprojection_id = '{my_reprojection.id}'
+        transformation_id = '{my_transformation.id}'
 ''')
 ```
 
@@ -93,9 +93,9 @@ client.list_data_requests()
 
 client.get_data_request(my_data_request.id)
 
-client.list_reprojections()
+client.list_transformations()
 
-client.get_reprojection(my_reprojection.id)
+client.get_transformation(my_transformation.id)
 ```
 
 ## License

{cecil-0.0.14 → cecil-0.0.16}/pyproject.toml

@@ -22,9 +22,9 @@ dependencies = [
 ]
 
 [tool.hatch.version]
-path = "__about__.py"
+path = "src/cecil/version.py"
 
 [tool.hatch.envs.hatch-test]
 extra-dependencies = [
     "responses"
-]
+]

cecil-0.0.16/src/cecil/__init__.py

@@ -0,0 +1,3 @@
+from .client import Client
+from .errors import Error
+from .version import __version__

{cecil-0.0.14 → cecil-0.0.16}/src/cecil/client.py

@@ -1,18 +1,25 @@
 import os
-from typing import Dict, List
-
 import requests
 import snowflake.connector
+
 from pydantic import BaseModel
 from requests import auth
+from typing import Dict, List
+
+from .errors import (
+    Error,
+    _handle_bad_request,
+    _handle_not_found,
+    _handle_unprocessable_entity,
+)
 
 from .models import (
     AOI,
     AOICreate,
     DataRequest,
     DataRequestCreate,
-    Reprojection,
-    ReprojectionCreate,
+    Transformation,
+    TransformationCreate,
     RecoverAPIKey,
     RecoverAPIKeyRequest,
     RotateAPIKey,
@@ -20,8 +27,7 @@ from .models import (
     SnowflakeCredentials,
 )
 
-# TODO: find a way to get this version from __about__.py
-SDK_VERSION = "0.0.14"
+from .version import __version__
 
 # TODO: Documentation (Google style)
 # TODO: Add HTTP retries
@@ -31,9 +37,7 @@ class Client:
     def __init__(self, env=None):
         self._api_auth = None
         self._base_url = (
-            "https://api.cecil.earth"
-            if env is None
-            else f"https://{env}-api.cecil.earth"
+            "https://api.cecil.earth" if env is None else f"https://{env}.cecil.earth"
         )
         self._snowflake_creds = None
 
@@ -65,27 +69,27 @@ class Client:
         res = self._get(url="/v0/data-requests")
         return [DataRequest(**record) for record in res["records"]]
 
-    def create_reprojection(
-        self, data_request_id: str, crs: str, resolution: float
-    ) -> Reprojection:
-        # TODO: check if data request is completed before creating reprojection
+    def create_transformation(
+        self, data_request_id: str, crs: str, spatial_resolution: float
+    ) -> Transformation:
+        # TODO: check if data request is completed before creating transformation
         res = self._post(
-            url="/v0/reprojections",
-            model=ReprojectionCreate(
+            url="/v0/transformations",
+            model=TransformationCreate(
                 data_request_id=data_request_id,
                 crs=crs,
-                resolution=resolution,
+                spatial_resolution=spatial_resolution,
             ),
         )
-        return Reprojection(**res)
+        return Transformation(**res)
 
-    def get_reprojection(self, id: str) -> Reprojection:
-        res = self._get(url=f"/v0/reprojections/{id}")
-        return Reprojection(**res)
+    def get_transformation(self, id: str) -> Transformation:
+        res = self._get(url=f"/v0/transformations/{id}")
+        return Transformation(**res)
 
-    def list_reprojections(self) -> List[Reprojection]:
-        res = self._get(url="/v0/reprojections")
-        return [Reprojection(**record) for record in res["records"]]
+    def list_transformations(self) -> List[Transformation]:
+        res = self._get(url="/v0/transformations")
+        return [Transformation(**record) for record in res["records"]]
 
     def query(self, sql):
         if self._snowflake_creds is None:
@@ -121,7 +125,7 @@ class Client:
         if skip_auth is False:
             self._set_auth()
 
-        headers = {"cecil-python-sdk-version": SDK_VERSION}
+        headers = {"cecil-python-sdk-version": __version__}
 
         try:
             r = requests.request(
@@ -135,14 +139,25 @@ class Client:
             r.raise_for_status()
             return r.json()
 
-        except requests.exceptions.ConnectionError as err:
-            raise ValueError("Connection error") from err
+        except requests.exceptions.ConnectionError:
+            raise Error("failed to connect to the Cecil Platform")
         except requests.exceptions.HTTPError as err:
-            message = f"Request failed with status code {err.response.status_code}"
-            if err.response.text != "":
-                message += f": {err.response.text}"
-
-            raise ValueError(message) from err
+            match err.response.status_code:
+                case 400:
+                    _handle_bad_request(err.response)
+                case 401:
+                    raise Error("unauthorised")
+                case 404:
+                    _handle_not_found(err.response)
+                case 422:
+                    _handle_unprocessable_entity(err.response)
+                case 500:
+                    raise Error("internal server error")
+                case _:
+                    raise Error(
+                        f"request failed with code {err.response.status_code}",
+                        err.response.text,
+                    )
 
     def _get(self, url: str, **kwargs) -> Dict:
         return self._request(method="get", url=url, **kwargs)

cecil-0.0.16/src/cecil/errors.py

@@ -0,0 +1,62 @@
+import json
+
+
+class Error(Exception):
+    def __init__(self, message: str, details=None):
+        self.message = message
+        self.details = details
+
+        if self.details is not None:
+            super().__init__(f"{self.message} \n{json.dumps(self.details, indent=2)}")
+            return
+
+        super().__init__(self.message)
+
+
+def _format_json_key(value: str):
+    return "".join(["_" + i.lower() if i.isupper() else i for i in value]).lstrip("_")
+
+
+def _is_json(value: str):
+    try:
+        json.loads(value)
+        return True
+    except ValueError:
+        return False
+
+
+def _handle_bad_request(response):
+    if not _is_json(response.text):
+        raise Error("bad request")
+
+    details = {}
+    for key, value in response.json().items():
+        details[_format_json_key(key)] = value
+
+    raise Error("bad request", details)
+
+
+def _handle_not_found(response):
+    if not _is_json(response.text):
+        raise Error("resource not found")
+
+    details = {}
+    for key, value in response.json().items():
+        details[_format_json_key(key)] = value
+
+    raise Error("resource not found", details)
+
+
+def _handle_unprocessable_entity(response):
+    if not _is_json(response.text):
+        raise Error(f"failed to process request")
+
+    res_body = response.json()
+    if "params" not in res_body:
+        raise Error(f"failed to process request")
+
+    details = {}
+    for key, value in res_body["params"].items():
+        details[_format_json_key(key)] = value
+
+    raise Error(f"failed to process request", details)

{cecil-0.0.14 → cecil-0.0.16}/src/cecil/models.py

@@ -1,23 +1,10 @@
 import datetime
-from enum import Enum
-from typing import Dict, List, Optional
+from typing import Dict
 
 from pydantic import BaseModel, ConfigDict, SecretStr
 from pydantic.alias_generators import to_camel
 
 
-class SubRequestStatus(str, Enum):
-    COMPLETED = "completed"
-    FAILED = "failed"
-    PROCESSING = "processing"
-
-
-class DataRequestStatus(str, Enum):
-    COMPLETED = "completed"
-    FAILED = "failed"
-    PROCESSING = "processing"
-
-
 class AOI(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     id: str
@@ -34,21 +21,11 @@ class AOICreate(BaseModel):
     geometry: Dict
 
 
-class SubRequest(BaseModel):
-    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
-    external_id: str
-    description: str
-    status: SubRequestStatus
-    error_message: Optional[str]
-
-
 class DataRequest(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     id: str
     aoi_id: str
     dataset_id: str
-    sub_requests: List[SubRequest]
-    status: DataRequestStatus
     created_at: datetime.datetime
     created_by: str
 
@@ -78,21 +55,21 @@ class RotateAPIKeyRequest(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
 
 
-class Reprojection(BaseModel):
+class Transformation(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     id: str
     data_request_id: str
     crs: str
-    resolution: float
+    spatial_resolution: float
     created_at: datetime.datetime
     created_by: str
 
 
-class ReprojectionCreate(BaseModel):
+class TransformationCreate(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     data_request_id: str
     crs: str
-    resolution: float
+    spatial_resolution: float
 
 
 class SnowflakeCredentials(BaseModel):

cecil-0.0.16/src/cecil/version.py

@@ -0,0 +1 @@
+__version__ = "0.0.16"

{cecil-0.0.14 → cecil-0.0.16}/tests/test_client.py

@@ -1,7 +1,7 @@
 import responses
 
 from src.cecil.client import Client
-from src.cecil.models import DataRequest, DataRequestStatus
+from src.cecil.models import DataRequest
 
 FROZEN_TIME = "2024-01-01T00:00:00.000Z"
 
@@ -20,8 +20,6 @@ def test_client_create_data_request():
             "id": "id",
             "aoiId": "aoi_id",
             "datasetId": "dataset_id",
-            "subRequests": [],
-            "status": "processing",
             "created_at": FROZEN_TIME,
             "created_by": "user_id",
         },
@@ -35,8 +33,6 @@ def test_client_create_data_request():
         id="id",
         aoiId="aoi_id",
         datasetId="dataset_id",
-        subRequests=[],
-        status="processing",
         created_at="2024-01-01T00:00:00.000Z",
         created_by="user_id",
     )
@@ -53,8 +49,6 @@ def test_client_list_data_requests():
                     "id": "data_request_id_1",
                     "aoiId": "aoi_id",
                     "datasetId": "dataset_id",
-                    "subRequests": [],  # TODO: Add some SubRequests
-                    "status": "processing",
                     "created_at": "2024-09-19T04:45:57.561Z",
                     "created_by": "user_id",
                 },
@@ -62,8 +56,6 @@ def test_client_list_data_requests():
                     "id": "data_request_id_2",
                     "aoiId": "aoi_id",
                     "datasetId": "dataset_id",
-                    "subRequests": [],  # TODO: Add some SubRequests
-                    "status": "completed",
                     "created_at": "2024-09-19T04:54:38.252Z",
                     "created_by": "user_id",
                 },
@@ -79,8 +71,6 @@ def test_client_list_data_requests():
             id="data_request_id_1",
             aoiId="aoi_id",
             datasetId="dataset_id",
-            subRequests=[],
-            status=DataRequestStatus.PROCESSING,
             created_at="2024-09-19T04:45:57.561Z",
             created_by="user_id",
         ),
@@ -88,8 +78,6 @@ def test_client_list_data_requests():
             id="data_request_id_2",
             aoiId="aoi_id",
             datasetId="dataset_id",
-            subRequests=[],
-            status=DataRequestStatus.COMPLETED,
             created_at="2024-09-19T04:54:38.252Z",
             created_by="user_id",
         ),

cecil-0.0.14/.gitignore

@@ -1,6 +0,0 @@
-.idea
-.venv
-__pycache__
-dist/*
-venv
-*.ipynb

cecil-0.0.14/Makefile

@@ -1,33 +0,0 @@
-HL = @printf "\033[36m>> $1\033[0m\n"
-
-default: help
-
-.PHONY: help
-help:
-	@echo "Usage: make <target>\n"
-	@grep -E ".+:\s.*?##" $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?##"}; {printf "\033[36m%-24s\033[0m %s\n", $$1, $$2}'
-
-.PHONY: build
-build: clean test ## Build package
-	$(call HL,build)
-	hatch build
-
-.PHONY: clean
-clean: ## Clean dist
-	$(call HL,clean)
-	hatch clean
-
-.PHONY: publish-test
-publish-test: build ## Publish package to testpypi
-	$(call HL,publish-test)
-	twine upload --repository testpypi dist/*
-
-.PHONY: publish-prod
-publish-prod: build ## Publish package to pypi
-	$(call HL,publish-prod)
-	twine upload --repository pypi dist/*
-
-.PHONY: test
-test: ## Run tests
-	$(call HL,test)
-	hatch test -v

cecil-0.0.14/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.0.14"

cecil-0.0.14/src/cecil/__init__.py

@@ -1 +0,0 @@
-from .client import Client