geobox 1.3.2__py3-none-any.whl → 1.3.3__py3-none-any.whl

geobox/api.py

@@ -781,16 +781,14 @@ class GeoboxClient:
         return VectorLayerView.get_view_by_name(self, name, user_id)
 
 
-    def create_tileset(self, name: str, layers: List[Dict], display_name: str = None, description: str = None,
+    def create_tileset(self, name: str, layers: List[Union['VectorLayer', 'VectorLayerView']], display_name: str = None, description: str = None,
                         min_zoom: int = None, max_zoom: int = None, user_id: int = None) -> 'Tileset':
         """
         Create a new tileset.
 
         Args:
             name (str): The name of the tileset.
-            layers (List[Dict]): The layers of the tileset. a list of dictionaries with the following keys:
-                - layer_type: The type of the layer. valid values are "vector" and "view".
-                - layer_uuid: The uuid of the layer.
+            layers (List['VectorLayer' | 'VectorLayerView']): list of vectorlayer and view objects to add to tileset.
             display_name (str, optional): The display name of the tileset.
             description (str, optional): The description of the tileset.
             min_zoom (int, optional): The minimum zoom level of the tileset.
@@ -802,19 +800,16 @@ class GeoboxClient:
 
         Example:
             >>> from geobox import GeoboxClient
+            >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> layers = [
-            ...     {
-            ...     "layer_type": "vector",
-            ...     "layer_uuid": "12345678-1234-5678-1234-567812345678"
-            ...     }
-            ... ]
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
             >>> tileset = client.create_tileset(name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
         """
         return Tileset.create_tileset(api=self, 
                                       name=name, 

geobox/enums.py

@@ -326,12 +326,6 @@ class QueryResultType(Enum):
     both = "both"
 
 
-class TilesetLayerType(Enum):
-    Vector = "vector"
-
-    View = "view"
-
-
 class FileOutputFormat(Enum):
     Shapefile = "Shapefile"
 

geobox/query.py

@@ -624,18 +624,16 @@ class Query(Base):
         return endpoint
 
 
-    def save_as_layer(self, layer_name: str, layer_type: 'QueryGeometryType') -> Dict:
+    def save_as_layer(self, layer_name: str, layer_type: 'QueryGeometryType' = None) -> Task:
         """
         Saves the query as a new layer.
 
         Args:
-            sql (str): The SQL statement for the query.
-            params (list): The parameters for the SQL statement.
             layer_name (str): The name of the new layer.
-            layer_type (QueryGeometryType): The type of the new layer.
+            layer_type (QueryGeometryType, optional): The type of the new layer.
 
         Returns:
-            Dict: The response from the API.
+            Task: The response task object.
             
         Raises:
             PermissionError: If the query is a read-only system query.
@@ -645,7 +643,7 @@ class Query(Base):
             >>> from geobox.query import Query
             >>> client = GeoboxClient()
             >>> query = Query.get_query(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> query.save_as_layer(layer_name='test', layer_type=QueryGeometryType.POLYGON)
+            >>> query.save_as_layer(layer_name='test')
         """
         self._check_access()
 
@@ -659,7 +657,7 @@ class Query(Base):
             "sql": self.sql,
             "params": params,
             "layer_name": layer_name,
-            "layer_type": layer_type.value
+            "layer_type": layer_type.value if layer_type else None
         })
 
         endpoint = urljoin(self.BASE_ENDPOINT, 'saveAsLayer/')

geobox/tileset.py

@@ -3,8 +3,8 @@ from typing import Dict, List, Optional, Union, TYPE_CHECKING
 
 from .base import Base
 from .vectorlayer import VectorLayer
+from .view import VectorLayerView
 from .task import Task
-from .enums import TilesetLayerType
 
 if TYPE_CHECKING:
     from . import GeoboxClient 
@@ -35,7 +35,7 @@ class Tileset(Base):
 
 
     @classmethod
-    def create_tileset(cls, api: 'GeoboxClient', name: str, layers: List[Dict], display_name: str = None, description: str = None,
+    def create_tileset(cls, api: 'GeoboxClient', name: str, layers: List[Union['VectorLayer', 'VectorLayerView']], display_name: str = None, description: str = None,
                         min_zoom: int = None, max_zoom: int = None, user_id: int = None) -> 'Tileset':
         """
         Create a new tileset.
@@ -43,9 +43,7 @@ class Tileset(Base):
         Args:
             api (GeoboxClient): The GeoboxClient instance for making requests.
             name (str): The name of the tileset.
-            layers (List[Dict]): The layers of the tileset. a list of dictionaries with the following keys:
-                - layer_type: The type of the layer. valid values are "vector" and "view".
-                - layer_uuid: The uuid of the layer.
+            layers (List['VectorLayer' | 'VectorLayerView']): list of vectorlayer and view objects to add to tileset.
             display_name (str, optional): The display name of the tileset.
             description (str, optional): The description of the tileset.
             min_zoom (int, optional): The minimum zoom level of the tileset.
@@ -59,34 +57,46 @@ class Tileset(Base):
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> layers = [
-            ...     {
-            ...     "layer_type": "vector",
-            ...     "layer_uuid": "12345678-1234-5678-1234-567812345678"
-            ...     }
-            ... ]
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
             >>> tileset = Tileset.create_tileset(client, 
             ...                                     name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
             or 
             >>> tileset = client.create_tileset(name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
         """
+        formatted_layers = []
+        for item in layers:
+            if type(item) == VectorLayer:
+                item_type = 'vector'
+
+            elif type(item) == VectorLayerView:
+                item_type = 'view'
+
+            else:
+                continue
+
+            formatted_layers.append({
+                'layer_type': item_type,
+                'layer_uuid': item.uuid
+            })
+
         data = {
             "name": name,
             "display_name": display_name,
             "description": description,
             "min_zoom": min_zoom,
             "max_zoom": max_zoom,
-            "layers": layers,
+            "layers": formatted_layers,
             "user_id": user_id
         }
         return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Tileset(api, item['uuid'], item))
@@ -283,7 +293,7 @@ class Tileset(Base):
         super().delete(urljoin(self.BASE_ENDPOINT, f'{self.uuid}/'))
     
     
-    def get_tileset_layers(self, **kwargs) -> List['VectorLayer']:
+    def get_layers(self, **kwargs) -> List['VectorLayer']:
         """
         Retrieves the layers of the tileset with optional parameters.
 
@@ -307,13 +317,14 @@ class Tileset(Base):
         Example:
 
         Returns:
-            List: A list of VectorLayer instances.
+            List: A list of VectorLayer or VectorLayerView instances.
 
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> tilesets = Tileset.get_tileset_layers()
+            >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layers = tileset.get_layers()
         """
         params = {
             'f': 'json',
@@ -328,57 +339,82 @@ class Tileset(Base):
             'shared': kwargs.get('shared', False)
         }
         endpoint = urljoin(self.BASE_ENDPOINT, f'{self.uuid}/layers/')
-        return super()._get_list(self.api, endpoint, params, factory_func=lambda api, item: VectorLayer(api, item['uuid'], item['layer_type'], item))
+        return super()._get_list(self.api, endpoint, params, factory_func=lambda api, item: VectorLayer(api, item['uuid'], item['layer_type'], item) if not item['is_view'] else \
+                                                                                            VectorLayerView(api, item['uuid'], item['layer_type'], item)                                    )
 
 
-    def add_layer(self, layer_type: TilesetLayerType, layer_uuid: str) -> None:
+    def add_layer(self, layer: Union['VectorLayer', 'VectorLayerView']) -> None:
         """
         Adds a layer to the tileset.
 
         Args:
-            layer_type (TilesetLayerType): The type of the layer. "vector" or "view".
-            layer_uuid (str): The UUID of the layer.
+            layer (VectorLayer | VectorLayerView): the layer object to add to the tileset
 
         Returns:
             None
 
+        Raises:
+            ValueError: if the layer input is not a 'VectorLayer' or 'VetorLayerview' object
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
             >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> tileset.add_layer_tileset(layer_type=TilesetLayerType.Vector, layer_uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> tileset.add_layer(layer)
         """
+        if type(layer) == VectorLayer:
+            layer_type = 'vector'
+
+        elif type(layer) == VectorLayerView:
+            layer_type = 'view'
+
+        else:
+            raise ValueError("layer input must be either 'VectorLayer' or 'VetorLayerview' object")
+
         data = {
-            "layer_type": layer_type.value,
-            "layer_uuid": layer_uuid
+            "layer_type": layer_type,
+            "layer_uuid": layer.uuid
         }
 
         endpoint = urljoin(self.endpoint, 'layers/')
         return self.api.post(endpoint, data, is_json=False)
 
 
-    def delete_layer(self, layer_type: TilesetLayerType, layer_uuid: str) -> None:
+    def delete_layer(self, layer: Union['VectorLayer', 'VectorLayerView']) -> None:
         """
         Deletes a layer from the tileset.
 
         Args:
-            layer_type (TilesetLayerType): The type of the layer. "vector" or "view".
-            layer_uuid (str): The UUID of the layer.
+            layer (VectorLayer | VectorLayerView): the layer object to delete from the tileset
 
         Returns:
             None
 
+        Raises:
+            ValueError: if the layer input is not a 'VectorLayer' or 'VetorLayerview' object
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
             >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> tileset.delete_layer_tileset(layer_type=TilesetLayerType.Vector, layer_uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> tileset.delete_layer(layer)
         """
+        if type(layer) == VectorLayer:
+            layer_type = 'vector'
+
+        elif type(layer) == VectorLayerView:
+            layer_type = 'view'
+
+        else:
+            raise ValueError("layer input must be either 'VectorLayer' or 'VetorLayerview' object")
+
         data = {
-            "layer_type": layer_type.value,
-            "layer_uuid": layer_uuid
+            "layer_type": layer_type,
+            "layer_uuid": layer.uuid
         }
 
         endpoint = urljoin(self.endpoint, 'layers/')

{geobox-1.3.2.dist-info → geobox-1.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geobox
-Version: 1.3.2
+Version: 1.3.3
 Summary: SDK for Geobox's APIs
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT

{geobox-1.3.2.dist-info → geobox-1.3.3.dist-info}/RECORD

@@ -1,11 +1,11 @@
 geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
-geobox/api.py,sha256=v-_Vay_xIXZRG3-0ahiOWxVT9QkrIyuOcd2KYFyVK04,100795
+geobox/api.py,sha256=spbIWSeYCml_rmiisDLQjFcvm6I_UJGobUJm9H-Z9sQ,100719
 geobox/apikey.py,sha256=FBio1PtGovAUaTE0HW9IJ55UuFdR_1ICk_FQhHu5dAE,7427
 geobox/attachment.py,sha256=XbGwfWWuFAMimj4tsjKBvlSLP-rhpNACCtxgRmUvcdY,11631
 geobox/base.py,sha256=p0UVZo9CINw0mW9o0nNR_VNCk7V1r-FrLQ_NH39WARE,12299
 geobox/basemap.py,sha256=fDWwkMf-F2NTE1tVLijoxQku55825b6gj8nk69TMOII,4386
 geobox/dashboard.py,sha256=MYyT3YJEGPCbTXHcYoZmn14rFOaut1J3idEA8bCdFgI,11762
-geobox/enums.py,sha256=eYD-SVXCSp4l08DlxymJTqYzTLouRziWhLZd7letnTM,6317
+geobox/enums.py,sha256=mGF6eXQlNHcUXV0AVMolI200a__g-S9wMjQ1p4ka28g,6244
 geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
 geobox/feature.py,sha256=3Kbc1LjIkBt1YqRAry84BrR7qxx9BexvBB3YQ8D9mGk,18504
 geobox/field.py,sha256=p9eitUpnsiGj6GUhjSomk6HWlsNJSbE-Oh_4VcjaqVo,10562
@@ -15,14 +15,14 @@ geobox/map.py,sha256=RjuhbOVQN-OBwjBtO46AosB_Ta348EA1nExBdnxH3nw,31252
 geobox/model3d.py,sha256=qRYCx-q9LpGhdu5oz3av0uUoiDimuk4BvXXwMW5bo9Q,12061
 geobox/mosaic.py,sha256=feBRsAgvhl0tKoghfZiQsxFntS7skAnzEYYuU4GKbP0,23672
 geobox/plan.py,sha256=_ZV9F6loG92uQZGJl_9T08Kg85g3hnODmpccSkTYVdw,11193
-geobox/query.py,sha256=KHUKx3vbdkwBQYsb9Lg9D3eHBEBFVVtqehqkd31mmjU,24216
+geobox/query.py,sha256=BGlCnglo7lZwvvmWqeWubafn3gAWE8tT08fBAwxFt4s,24097
 geobox/raster.py,sha256=ex2nUiMGwGN-9Zp3-Fotj9Z2noJRkyDf4-ZhwIponHw,29459
 geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
 geobox/scene.py,sha256=Sz2tiyJk-bXYjktfcp1d2gGrW3gt2T4D1FAMoRHOCng,11369
 geobox/settings.py,sha256=rGRdM18Vo7xnjfZXPLRMbKeoVC_lZmzkNRPS0SQv05o,5660
 geobox/task.py,sha256=eLMgbhcYTADooWqKDPh6Jlh5S5oqxMMKoYIm0YPVZvg,13519
 geobox/tile3d.py,sha256=MHDoj2OIUf3VMQtq7ysrayh8njAPSgwgPJCm4ySEB7A,10472
-geobox/tileset.py,sha256=F_oEV0TERMc2seLcYNu-i_TF4MNSdXPUWcxBCSR8aFw,22242
+geobox/tileset.py,sha256=I22RQggG4nuxibyf87Pm7uFliH-pAkesHlujaqMRfu8,23499
 geobox/usage.py,sha256=_54xL-n-2Bg9wGpoOBKnh85WqdpMWEtqxRJVaFlVWe0,7908
 geobox/user.py,sha256=YY72uRvjKUUWUZbxhrft37FVBlqDeosPMf3EpMVBhc0,15069
 geobox/utils.py,sha256=qLtchKIdw-az3KCiiFv0-Cpmx9RfBxORjlATvVyDIaQ,1314
@@ -30,8 +30,8 @@ geobox/vectorlayer.py,sha256=yK_5ZD7eBAbRV2ruZCMptCtNU-S0AMvsAFiGIcLf3LQ,52853
 geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
 geobox/view.py,sha256=sIi6Mi7NUAX5gN83cpubD3l7AcZ-1g5kG2NKHeVeW-g,37518
 geobox/workflow.py,sha256=6hKnSw4G0_ZlgmUb0g3fxT-UVsFbiYpF2FbEO5fpQv0,11606
-geobox-1.3.2.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-1.3.2.dist-info/METADATA,sha256=Upop-Ls1kfz5xjJKkxZ9WTKJqZEepRFc-4vptsZ7A70,2556
-geobox-1.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-1.3.2.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-1.3.2.dist-info/RECORD,,
+geobox-1.3.3.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-1.3.3.dist-info/METADATA,sha256=dU6XTrCrrBCxwcVm01tBYRJfdsUuBErYGUMfdKF7Wu4,2556
+geobox-1.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-1.3.3.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-1.3.3.dist-info/RECORD,,