geobox 1.3.2__tar.gz → 1.3.4__tar.gz

{geobox-1.3.2 → geobox-1.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geobox
-Version: 1.3.2
+Version: 1.3.4
 Summary: SDK for Geobox's APIs
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT
@@ -31,6 +31,8 @@ Geobox® is a cloud-based GIS platform that enables users (local governments, co
 
 Geobox python SDK provides seamless integration with the Geobox API, enabling developers to work with geospatial data and services programmatically. This comprehensive toolkit empowers applications to leverage advanced geospatial capabilities including data management and analysis.
 
+[Here](https://geobox.readthedocs.io) you can find the official documentation for Geobox Python SDK.
+
 Installation
 ============
 

{geobox-1.3.2 → geobox-1.3.4}/README.md

@@ -5,6 +5,8 @@ Geobox® is a cloud-based GIS platform that enables users (local governments, co
 
 Geobox python SDK provides seamless integration with the Geobox API, enabling developers to work with geospatial data and services programmatically. This comprehensive toolkit empowers applications to leverage advanced geospatial capabilities including data management and analysis.
 
+[Here](https://geobox.readthedocs.io) you can find the official documentation for Geobox Python SDK.
+
 Installation
 ============
 

{geobox-1.3.2 → geobox-1.3.4}/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-1.3.2 → geobox-1.3.4}/geobox/attachment.py

@@ -31,7 +31,7 @@ class Attachment(Base):
         """
         super().__init__(api, data=data)
         self.attachment_id = attachment_id
-        self.endpoint = urljoin(self.BASE_ENDPOINT, str(self.attachment_id))
+        self.endpoint = f"{self.BASE_ENDPOINT}{str(self.attachment_id)}/"
 
 
     def __repr__(self) -> str:
@@ -293,6 +293,5 @@ class Attachment(Base):
             >>> attachment.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail"
-        return endpoint
+        return super().thumbnail(format='')
     

{geobox-1.3.2 → geobox-1.3.4}/geobox/base.py

@@ -362,3 +362,24 @@ class Base:
         
         # If all parsing fails, return the original string
         return date_string
+
+
+    def thumbnail(self, format='.png') -> str:
+        """
+        Get the thumbnail URL of the resource.
+        
+        Returns:
+            str: The thumbnail URL
+
+        Raises:
+            ValueError: 
+        """
+        endpoint = f'{self.api.base_url}{self.endpoint}thumbnail{format}'
+        
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+            
+        elif not self.api.access_token and not self.api.apikey:
+            raise ValueError("either access_token or apikey must be available for this action.")
+        
+        return endpoint

{geobox-1.3.2 → geobox-1.3.4}/geobox/basemap.py

@@ -23,7 +23,7 @@ class Basemap(Base):
             data (Dict): The data of the basemap.
         """
         super().__init__(api, data=data)
-        self.endpoint = f"{self.BASE_ENDPOINT}{self.data.get('name')}"
+        self.endpoint = f"{self.BASE_ENDPOINT}{self.data.get('name')}/"
 
 
     @classmethod
@@ -107,7 +107,11 @@ class Basemap(Base):
         Returns:
             str: the wmts url
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}/wmts" 
+        endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f"{endpoint}?apikey={self.api.apikey}"
+            
         return endpoint
     
 

{geobox-1.3.2 → geobox-1.3.4}/geobox/dashboard.py

@@ -243,8 +243,7 @@ class Dashboard(Base):
             >>> dashboard.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

{geobox-1.3.2 → geobox-1.3.4}/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-1.3.2 → geobox-1.3.4}/geobox/map.py

@@ -2,7 +2,7 @@ from typing import Dict, List, Optional, Union, TYPE_CHECKING
 from urllib.parse import urljoin, urlencode
 
 from .base import Base
-from .utils import clean_data
+from .utils import clean_data, join_url_params
 from .model3d import Model
 
 if TYPE_CHECKING:
@@ -276,8 +276,7 @@ class Map(Base):
             >>> map.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail.png"
-        return endpoint
+        return super().thumbnail()
     
 
     def set_readonly(self, readonly: bool) -> None:
@@ -351,6 +350,10 @@ class Map(Base):
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
         if scale:
             endpoint = f"{endpoint}?scale={scale}"
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
 
     

{geobox-1.3.2 → geobox-1.3.4}/geobox/model3d.py

@@ -258,11 +258,7 @@ class Model(Base):
             >>> model = Model.get_model(api=client, uuid="12345678-1234-5678-1234-567812345678")
             >>> model.thumbnail
         """
-        if not self.uuid:
-            raise ValueError("Model UUID is required.")
-        
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}/thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

{geobox-1.3.2 → geobox-1.3.4}/geobox/mosaic.py

@@ -295,14 +295,14 @@ class Mosaic(Raster):
         return super().get_point(lat, lng)
 
 
-    def get_render_png_url(self, x: int, y: int, z: int, **kwargs) -> str:
+    def get_render_png_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}', **kwargs) -> str:
         """
         Get the tile render URL of the mosaic.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Keyword Args:
             indexes (str, optional): list of comma separated band indexes to be rendered. e.g. 1, 2, 3
@@ -326,14 +326,14 @@ class Mosaic(Raster):
         return super().get_render_png_url(x, y, z, **kwargs)
     
 
-    def get_tile_png_url(self, x: int, y: int, z: int) -> str:
+    def get_tile_png_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}') -> str:
         """
         Get the tile PNG URL of the mosaic.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Returns:
             str: The tile PNG URL of the mosaic.

{geobox-1.3.2 → geobox-1.3.4}/geobox/query.py

@@ -620,22 +620,19 @@ class Query(Base):
             str: The thumbnail URL.
         """
         self._check_access()
-        endpoint = f'{self.api.base_url}{self.endpoint}thumbnail.png'
-        return endpoint
+        return super().thumbnail()
 
 
-    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 +642,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 +656,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-1.3.2 → geobox-1.3.4}/geobox/raster.py

@@ -6,7 +6,7 @@ import requests
 import sys
 
 from .base import Base
-from .utils import clean_data
+from .utils import clean_data, join_url_params
 from .task import Task
 
 if TYPE_CHECKING:
@@ -231,8 +231,7 @@ class Raster(Base):
             >>> raster = Raster.get_raster(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> raster.thumbnail
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail/')
-        return endpoint
+        return super().thumbnail(format='')
     
     
     @property
@@ -511,19 +510,20 @@ class Raster(Base):
             'colormap': kwargs.get('colormap')
         })
         query_string = urlencode(params)
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}render/{z}/{x}/{y}.png')
-        endpoint = urljoin(endpoint, f'?{query_string}')
+        endpoint = f'{self.api.base_url}{self.endpoint}render/{z}/{x}/{y}.png'
+        if query_string:
+            endpoint = f'{endpoint}?{query_string}'
         return endpoint
     
 
-    def get_tile_pbf_url(self, x: int, y: int, z: int, indexes: str = None) -> str:
+    def get_tile_pbf_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}', indexes: str = None) -> str:
         """
         Get the URL of the tile.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
             indexes (str, optional): list of comma separated band indexes to be rendered. e.g. 1, 2, 3
 
         Returns:
@@ -542,17 +542,21 @@ class Raster(Base):
         query_string = urlencode(params)
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}tiles/{z}/{x}/{y}.pbf')
         endpoint = urljoin(endpoint, f'?{query_string}')
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
     
 
-    def get_tile_png_url(self, x: int, y: int, z: int) -> str:
+    def get_tile_png_url(self, x: int = 'x', y: int = 'y', z: int = 'z') -> str:
         """
         Get the URL of the tile.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Returns:
             str: The URL of the tile.
@@ -564,7 +568,11 @@ class Raster(Base):
             >>> raster = Raster.get_raster(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> raster.get_tile_png_url(x=10, y=20, z=1)
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}tiles/{z}/{x}/{y}.png')
+        endpoint = f'{self.api.base_url}{self.endpoint}tiles/{z}/{x}/{y}.png'
+            
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+
         return endpoint
 
 
@@ -606,6 +614,10 @@ class Raster(Base):
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
         if scale:
             endpoint = f"{endpoint}?scale={scale}"
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
 
 

{geobox-1.3.2 → geobox-1.3.4}/geobox/scene.py

@@ -244,8 +244,7 @@ class Scene(Base):
             >>> scene.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

{geobox-1.3.2 → geobox-1.3.4}/geobox/tile3d.py

@@ -1,10 +1,10 @@
 from typing import List, Dict, Optional, TYPE_CHECKING, Union
-from urllib.parse import urljoin
 
 from .base import Base
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .user import User
 
 
 class Tile3d(Base):
@@ -199,8 +199,7 @@ class Tile3d(Base):
             >>> tile.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
 
 
     def get_item(self, path: str) -> Dict: