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

cecil/client.py

@@ -1,40 +1,42 @@
 import os
+from typing import Dict, List
+
+import pandas as pd
 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_too_many_requests,
     _handle_unprocessable_entity,
 )
-
 from .models import (
     AOI,
     AOICreate,
     DataRequest,
     DataRequestCreate,
-    Transformation,
-    TransformationCreate,
+    OrganisationCreate,
     RecoverAPIKey,
     RecoverAPIKeyRequest,
     RotateAPIKey,
     RotateAPIKeyRequest,
+    SignUpRequest,
+    SignUpResponse,
     SnowflakeCredentials,
+    Transformation,
+    TransformationCreate,
+    User,
+    UserCreate,
 )
-
 from .version import __version__
 
-# TODO: Documentation (Google style)
-# TODO: Add HTTP retries
-
 
 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}.cecil.earth"
@@ -65,14 +67,13 @@ 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_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/transformations",
             model=TransformationCreate(
@@ -91,7 +92,7 @@ class Client:
         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)
@@ -108,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,
         )
@@ -116,10 +117,43 @@ 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:
@@ -141,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)
@@ -151,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

@@ -36,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
@@ -77,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

@@ -1 +1 @@
-__version__ = "0.0.16"
+__version__ = "0.0.17"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cecil
-Version: 0.0.16
+Version: 0.0.17
 Summary: Python SDK for Cecil Earth
 License-Expression: MIT
 License-File: LICENSE.txt

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.16.dist-info/RECORD

@@ -1,9 +0,0 @@
-cecil/__init__.py,sha256=AEcRl73BDSAQe6W0d1PDD87IEcumARtREl7dCVa_YQY,86
-cecil/client.py,sha256=hykvGQrpuAEQR_TawLKCwc_mWsjD72uxAZHaOTZjf1M,5764
-cecil/errors.py,sha256=r9NNRtv_oO_hblnh-VOlAf767cJqmlnbJfHB63OA_zY,1538
-cecil/models.py,sha256=xkjrLAOenJboRtzRPihT-C8jpadngePz4KzLNJoemHM,2012
-cecil/version.py,sha256=8ss7zPyQ3YfaQJw9IIGX35NOL7ASZ7-LErAxKnQDN7c,23
-cecil-0.0.16.dist-info/METADATA,sha256=7f2D9tc10goXMoeFgZqjHWeENrVyUq6H0OXmma75eWY,2659
-cecil-0.0.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cecil-0.0.16.dist-info/licenses/LICENSE.txt,sha256=mUexcmfYx3bG1VIzAdQTOf_NzStYw6-QkKVdUY_d4i4,1066
-cecil-0.0.16.dist-info/RECORD,,