cecil 0.0.15__py3-none-any.whl → 0.0.17__py3-none-any.whl

cecil/__init__.py

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

cecil/client.py

@@ -1,6 +1,7 @@
 import os
 from typing import Dict, List
 
+import pandas as pd
 import requests
 import snowflake.connector
 from pydantic import BaseModel
@@ -10,37 +11,35 @@ from .errors import (
     Error,
     _handle_bad_request,
     _handle_not_found,
+    _handle_too_many_requests,
     _handle_unprocessable_entity,
 )
-
 from .models import (
     AOI,
     AOICreate,
     DataRequest,
     DataRequestCreate,
-    Reprojection,
-    ReprojectionCreate,
+    OrganisationCreate,
     RecoverAPIKey,
     RecoverAPIKeyRequest,
     RotateAPIKey,
     RotateAPIKeyRequest,
+    SignUpRequest,
+    SignUpResponse,
     SnowflakeCredentials,
+    Transformation,
+    TransformationCreate,
+    User,
+    UserCreate,
 )
-
-# TODO: find a way to get this version from __about__.py
-SDK_VERSION = "0.0.15"
-
-# TODO: Documentation (Google style)
-# TODO: Add HTTP retries
+from .version import __version__
 
 
 class Client:
-    def __init__(self, env=None):
+    def __init__(self, env: str = None) -> 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
 
@@ -68,33 +67,32 @@ class Client:
         res = self._get(url=f"/v0/data-requests/{id}")
         return DataRequest(**res)
 
-    def list_data_requests(self):
+    def list_data_requests(self) -> List[DataRequest]:
         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:
         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):
+    def query(self, sql: str) -> pd.DataFrame:
         if self._snowflake_creds is None:
             res = self._get(url="/v0/data-access-credentials")
             self._snowflake_creds = SnowflakeCredentials(**res)
@@ -111,7 +109,7 @@ class Client:
 
     def recover_api_key(self, email: str) -> RecoverAPIKey:
         res = self._post(
-            url=f"/v0/recover-api-key",
+            url="/v0/api-key/recover",
             model=RecoverAPIKeyRequest(email=email),
             skip_auth=True,
         )
@@ -119,16 +117,49 @@ class Client:
         return RecoverAPIKey(**res)
 
     def rotate_api_key(self) -> RotateAPIKey:
-        res = self._post(url=f"/v0/rotate-api-key", model=RotateAPIKeyRequest())
+        res = self._post(url=f"/v0/api-key/rotate", model=RotateAPIKeyRequest())
 
         return RotateAPIKey(**res)
 
+    def sign_up(
+        self, organisation: Dict[str, str], user: Dict[str, str]
+    ) -> SignUpResponse:
+        res = self._post(
+            url="/v0/sign-up",
+            model=SignUpRequest(
+                organisation=OrganisationCreate(**organisation),
+                user=UserCreate(**user),
+            ),
+            skip_auth=True,
+        )
+
+        return SignUpResponse(**res)
+
+    def create_user(self, first_name: str, last_name: str, email: str) -> User:
+        res = self._post(
+            url="/v0/users",
+            model=UserCreate(
+                first_name=first_name,
+                last_name=last_name,
+                email=email,
+            ),
+        )
+        return User(**res)
+
+    def get_user(self, id: str) -> User:
+        res = self._get(url=f"/v0/users/{id}")
+        return User(**res)
+
+    def list_users(self) -> List[User]:
+        res = self._get(url="/v0/users")
+        return [User(**record) for record in res["records"]]
+
     def _request(self, method: str, url: str, skip_auth=False, **kwargs) -> Dict:
 
         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(
@@ -144,7 +175,12 @@ class Client:
 
         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}"
+
             match err.response.status_code:
                 case 400:
                     _handle_bad_request(err.response)
@@ -154,6 +190,8 @@ class Client:
                     _handle_not_found(err.response)
                 case 422:
                     _handle_unprocessable_entity(err.response)
+                case 429:
+                    _handle_too_many_requests(err.response)
                 case 500:
                     raise Error("internal server error")
                 case _:

cecil/errors.py

@@ -47,6 +47,18 @@ def _handle_not_found(response):
     raise Error("resource not found", details)
 
 
+def _handle_too_many_requests(response):
+    if not _is_json(response.text):
+        raise Error("too many requests")
+
+    details = {}
+
+    for key, value in response.json().items():
+        details[_format_json_key(key)] = value
+
+    raise Error("too many requests", details)
+
+
 def _handle_unprocessable_entity(response):
     if not _is_json(response.text):
         raise Error(f"failed to process request")

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
 
@@ -59,6 +36,11 @@ class DataRequestCreate(BaseModel):
     dataset_id: str
 
 
+class OrganisationCreate(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    name: str
+
+
 class RecoverAPIKey(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
     message: str
@@ -78,21 +60,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):
@@ -100,3 +82,31 @@ class SnowflakeCredentials(BaseModel):
     account: SecretStr
     user: SecretStr
     password: SecretStr
+
+
+class User(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    id: str
+    first_name: str
+    last_name: str
+    email: str
+    created_at: datetime.datetime
+    created_by: str
+
+
+class UserCreate(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    first_name: str
+    last_name: str
+    email: str
+
+
+class SignUpRequest(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    organisation: OrganisationCreate
+    user: UserCreate
+
+
+class SignUpResponse(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    message: str

cecil/version.py

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

{cecil-0.0.15.dist-info → cecil-0.0.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: cecil
-Version: 0.0.15
+Version: 0.0.17
 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.17.dist-info/RECORD

@@ -0,0 +1,9 @@
+cecil/__init__.py,sha256=AEcRl73BDSAQe6W0d1PDD87IEcumARtREl7dCVa_YQY,86
+cecil/client.py,sha256=n8Ft-K1XLt430RCM6jUgBwWhwQlCJT8umyZp6RKpIyw,7054
+cecil/errors.py,sha256=ZNiSTYH2MgNZ7tNIgV07-Ge3KtmdncfzWiBi9yjURGs,1818
+cecil/models.py,sha256=0n5q7oUA7khdc5eB6C8aSW6Yx5LgyN_fA-GHb8y9Z7M,2834
+cecil/version.py,sha256=WlMBNrzKywm5RAbqEVgEgcG7Opc4cf3-wpAnO8PdoEI,23
+cecil-0.0.17.dist-info/METADATA,sha256=pK-PX-p6uyf-_MNbICW_ukGHnKzdnHiSFz5pFW3dOLw,2659
+cecil-0.0.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cecil-0.0.17.dist-info/licenses/LICENSE.txt,sha256=mUexcmfYx3bG1VIzAdQTOf_NzStYw6-QkKVdUY_d4i4,1066
+cecil-0.0.17.dist-info/RECORD,,

{cecil-0.0.15.dist-info → cecil-0.0.17.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

cecil-0.0.15.dist-info/RECORD

@@ -1,8 +0,0 @@
-cecil/__init__.py,sha256=9-O5DAnOHvBuzPAjkK10GiOnCY9rb4SW1k0CIrHorr0,53
-cecil/client.py,sha256=4ft1FL6KePfleTf-oepi10yRJ3RdVeZ0qNRdFyLm6c8,5783
-cecil/errors.py,sha256=r9NNRtv_oO_hblnh-VOlAf767cJqmlnbJfHB63OA_zY,1538
-cecil/models.py,sha256=6p9AedCDdkK-ptK2r5pc9AKG8rgZHw-YYDvRgXPAQqI,2544
-cecil-0.0.15.dist-info/METADATA,sha256=wnQowxMqcWRjlNsThxwypFnck_TuDDFmNCzZr34_Y54,2677
-cecil-0.0.15.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-cecil-0.0.15.dist-info/licenses/LICENSE.txt,sha256=mUexcmfYx3bG1VIzAdQTOf_NzStYw6-QkKVdUY_d4i4,1066
-cecil-0.0.15.dist-info/RECORD,,