geobox 1.3.4__tar.gz → 1.4.1__tar.gz

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

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

{geobox-1.3.4 → geobox-1.4.1}/geobox/api.py

@@ -20,6 +20,7 @@ from .map import Map
 from .user import User, UserRole, UserStatus, Session
 from .query import Query
 from .workflow import Workflow
+from .layout import Layout
 from .version import VectorLayerVersion
 from .tile3d import Tile3d
 from .settings import SystemSettings
@@ -28,7 +29,7 @@ from .route import Routing
 from .plan import Plan
 from .dashboard import Dashboard
 from .basemap import Basemap
-from .attachment import Attachment, AttachmentResourceType
+from .attachment import Attachment
 from .apikey import ApiKey
 from .log import Log
 from .usage import Usage, UsageScale, UsageParam
@@ -1535,7 +1536,7 @@ class GeoboxClient:
         Example:
             >>> from geobox import GeoboxClient
             >>> client = GeoboxClient()
-            >>> workflows = client.get_workflow(q="name LIKE '%My workflow%'")
+            >>> workflows = client.get_workflows(q="name LIKE '%My workflow%'")
         """
         return Workflow.get_workflows(self, **kwargs)
     
@@ -1681,6 +1682,105 @@ class GeoboxClient:
         return VectorLayerVersion.get_version_by_name(self, name, user_id)
     
 
+    def get_layouts(self, **kwargs) -> Union[List['Layout'], int]:
+        """
+        Get list of layouts with optional filtering and pagination.
+
+        Keyword Args:
+            q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
+            search (str): search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value. NOTE: if q param is defined this param will be ignored.
+            search_fields (str): comma separated list of fields for searching.
+            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
+            return_count (bool): Whether to return total count. default is False.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            user_id (int): Specific user. privileges required.
+            shared (bool): Whether to return shared layouts. default is False.
+
+        Returns:
+            List[Layout] | int: A list of layout instances or the total number of layouts.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> layouts = client.get_layouts(q="name LIKE '%My layout%'")
+        """
+        return Layout.get_layouts(self, **kwargs)
+    
+
+    def create_layout(self,
+                    name: str, 
+                    display_name: str = None, 
+                    description: str = None, 
+                    settings: Dict = {}, 
+                    thumbnail: str = None, 
+                    user_id: int = None) -> 'Layout':
+        """
+        Create a new layout.
+
+        Args:
+            name (str): The name of the layout.
+            display_name (str): The display name of the layout.
+            description (str): The description of the layout.
+            settings (Dict): The settings of the layout.
+            thumbnail (str): The thumbnail of the layout.
+            user_id (int): Specific user. privileges layout.
+
+        Returns:
+            Layout: The newly created layout instance.
+
+        Raises:
+            ValidationError: If the layout data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> layout = client.create_layout(name="my_layout")
+        """
+        return Layout.create_layout(self, name, display_name, description, settings, thumbnail, user_id)
+
+
+    def get_layout(self, uuid: str, user_id: int = None) -> 'Layout':
+        """
+        Get a layout by its UUID.
+
+        Args:
+            uuid (str): The UUID of the layout to get.
+            user_id (int): Specific user. privileges required.
+
+        Returns:
+            Layout: The layout object.
+
+        Raises:
+            NotFoundError: If the layout with the specified UUID is not found.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> layout = client.get_layout(uuid="12345678-1234-5678-1234-567812345678")
+        """
+        return Layout.get_layout(self, uuid, user_id)
+
+
+    def get_layout_by_name(self, name: str, user_id: int = None) -> Union['Layout', None]:
+        """
+        Get a layout by name
+
+        Args:
+            name (str): the name of the layout to get
+            user_id (int, optional): specific user. privileges required.
+
+        Returns:
+            Layout | None: returns the layout if a layout matches the given name, else None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> layout = client.get_layout_by_name(name='test')
+        """
+        return Layout.get_layout_by_name(self, name, user_id)
+
+
     def get_3dtiles(self, **kwargs) -> Union[List['Tile3d'], int]:
         """
         Get list of 3D Tiles with optional filtering and pagination.
@@ -2016,6 +2116,25 @@ class GeoboxClient:
         return Plan.get_plan(self, plan_id)
     
 
+    def get_plan_by_name(self, name: str) -> Union['Plan', None]:
+        """
+        Get a plan by name
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): the name of the plan to get
+
+        Returns:
+            Plan | None: returns the plan if a plan matches the given name, else None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> plan = client.get_plan_by_name(name='test')
+        """
+        return Plan.get_plan_by_name(self, name)
+    
+
     def get_dashboards(self, **kwargs) -> Union[List['Dashboard'], int]:
         """
         Get list of Dashboards
@@ -2175,13 +2294,12 @@ class GeoboxClient:
         return Basemap.proxy_basemap(self, url)
     
 
-    def get_attachments(self, resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
+    def get_attachments(self, resource: Union['Map', 'VectorLayer', 'VectorLayerView'], **kwargs) -> List['Attachment']:
         """
-        Get list of attachments with optional filtering and pagination.
+        Get the resouces attachments
 
         Args:
-            resource_type (AttachmentResourceType): The resource type of the attachment. options are: Map, Vector, View
-            resource_uuid (str): The Resoource uuid of the attachment.
+            resource (Map | VectorLayer | VectorLayerView): options are: Map, Vector, View objects
 
         Keyword Args:
             element_id (str): the id of the element with attachment.
@@ -2194,12 +2312,17 @@ class GeoboxClient:
         Returns:
             List[Attachment] | int: A list of attachments instances or the total number of attachments.
 
+        Raises:
+            TypeError: if the resource type is not supported
+
         Example:
             >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
             >>> client = GeoboxClient()
-            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
+            >>> map = client.get_maps()[0]
+            >>> attachments = client.get_attachments(resource=map)
         """
-        return Attachment.get_attachments(self, resource_type, resource_uuid, **kwargs)
+        return Attachment.get_attachments(self, resource=resource, **kwargs)
     
 
     def create_attachment(self,

{geobox-1.3.4 → geobox-1.4.1}/geobox/apikey.py

@@ -176,11 +176,14 @@ class ApiKey(Base):
             >>> apikey = ApiKey.get_apikey(client, key_id=1)
             >>> apikey.update(name="updated_name")
         """
-        data = {
+        data = clean_data({
             "name": name,
             "user_id": user_id
-        }
-        return super()._update(self.endpoint, data)
+        })
+
+        response = self.api.put(self.endpoint, data, is_json=False)
+        self._update_properties(response)
+        return response
 
 
     def delete(self) -> None:

{geobox-1.3.4 → geobox-1.4.1}/geobox/attachment.py

@@ -3,7 +3,6 @@ from urllib.parse import urljoin
 
 from .base import Base
 from .utils import clean_data
-from .enums import AttachmentResourceType
 from .map import Map
 from .vectorlayer import VectorLayer
 from .view import VectorLayerView
@@ -56,14 +55,13 @@ class Attachment(Base):
 
 
     @classmethod
-    def get_attachments(cls, api: 'GeoboxClient', resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
+    def get_attachments(cls, api: 'GeoboxClient', resource: Union['Map', 'VectorLayer', 'VectorLayerView'], **kwargs) -> Union[List['Attachment'], int]:
         """
         Get list of attachments with optional filtering and pagination.
 
         Args:
             api (GeoboxClient): The GeoboxClient instance for making requests.
-            resource_type (AttachmentResourceType): The resource type of the attachment. options are: Map, Vector, View
-            resource_uuid (str): The Resoource uuid of the attachment.
+            resource (Map | VectorLayer | VectorLayerView): options are: Map, Vector, View objects
 
         Keyword Args:
             element_id (str): the id of the element with attachment.
@@ -76,17 +74,34 @@ class Attachment(Base):
         Returns:
             List[Attachment] | int: A list of attachments instances or the total number of attachments.
 
+        Raises:
+            TypeError: if the resource type is not supported
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.attachment import Attachment
             >>> client = GeoboxClient()
-            >>> attachments = Attachment.get_attachments(client, q="name LIKE '%My attachment%'")
+            >>> map = client.get_maps()[0]
+            >>> attachments = Attachment.get_attachments(client, resource=map, q="name LIKE '%My attachment%'")
             or
-            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
+            >>> attachments = client.get_attachments(resource=map, q="name LIKE '%My attachment%'")
         """
+        if type(resource) == VectorLayer:
+            resource_type = 'vector'
+
+        elif type(resource) == VectorLayerView:
+            resource_type = 'view'
+
+        elif type(resource) == Map:
+            resource_type = 'map'
+
+        else:
+            raise TypeError('resource must be a vectorlayer or view or map object')
+
+
         params = {
-           'resource_type': resource_type.value,
-           'resource_uuid': resource_uuid,
+           'resource_type': resource_type,
+           'resource_uuid': resource.uuid,
            'element_id': kwargs.get('element_id'),
            'search': kwargs.get('search'),
            'order_by': kwargs.get('order_by'),
@@ -155,13 +170,13 @@ class Attachment(Base):
             ...                                             description="Attachment Description")
         """
         if isinstance(resource, VectorLayer):
-            resource_type = AttachmentResourceType.Vector.value
+            resource_type = 'vector'
 
         if isinstance(resource, VectorLayerView):
-            resource_type = AttachmentResourceType.View.value
+            resource_type = 'view'
 
         if isinstance(resource, Map):
-            resource_type = AttachmentResourceType.Map.value
+            resource_type = 'map'
 
         data = {
             "name": name,
@@ -171,7 +186,7 @@ class Attachment(Base):
             "loc_y": loc_y,
             "resource_type": resource_type,
             "resource_uuid": resource.uuid,
-            "element_id": feature.id,
+            "element_id": feature.id if feature else None,
             "file_id": file.id
             }
         return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Attachment(api, item['id'], item))

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

@@ -95,8 +95,7 @@ class Basemap(Base):
         Returns:
             str: the thumbnail url
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}/thumbnail.png" 
-        return endpoint
+        return super().thumbnail()
     
 
     @property

{geobox-1.3.4 → geobox-1.4.1}/geobox/enums.py

@@ -19,6 +19,7 @@ class PublishFileType(Enum):
     VECTOR = 'vector'
     RASTER = 'raster'
     MODEL3D = 'model3d'
+    Tiles3D = 'tiles3d'
 
 class FileType(Enum):
     Compressed = 'Compressed'
@@ -36,6 +37,7 @@ class FileType(Enum):
     FileGDB = 'FileGDB'
     GeoTIFF = 'GeoTIFF'
     GeoJSON = 'GeoJSON'
+    ThreedTiles = 'ThreedTiles'
 
 class FileFormat(Enum):
     # Spatial Data Formats
@@ -270,14 +272,6 @@ class UserStatus(Enum):
     DISABLED = "Disabled"
 
 
-class AttachmentResourceType(Enum):
-    Map = "map"
-
-    Vector = "vector"
-
-    View = "view"
-
-
 class MaxLogPolicy(Enum):
     OverwriteFirstLog = "OverwriteFirstLog"
 

{geobox-1.3.4 → geobox-1.4.1}/geobox/file.py

@@ -429,6 +429,9 @@ class File(Base):
                         FileType(self.layers[0]['format']).value in ['GLB']):
                 publish_as = PublishFileType.MODEL3D
 
+            elif self.file_type.value in ['ThreedTiles']:
+                publish_as = PublishFileType.Tiles3D
+
             else:
                 raise ValidationError('Unknown format')
 

geobox-1.4.1/geobox/layout.py

@@ -0,0 +1,314 @@
+from typing import List, Dict, Optional, TYPE_CHECKING, Union
+
+from .base import Base
+
+if TYPE_CHECKING:
+    from . import GeoboxClient
+    from .user import User
+
+class Layout(Base):
+
+    BASE_ENDPOINT = 'layouts/'
+
+    def __init__(self, 
+                 api: 'GeoboxClient', 
+                 uuid: str,
+                 data: Optional[Dict] = {}):
+        """
+        Initialize a layout instance.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The unique identifier for the layout.
+            data (Dict): The data of the layout.
+        """
+        super().__init__(api, uuid=uuid, data=data)
+
+
+    @classmethod
+    def get_layouts(cls, api: 'GeoboxClient', **kwargs) -> Union[List['Layout'], int]:
+        """
+        Get list of layouts with optional filtering and pagination.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+
+        Keyword Args:
+            q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
+            search (str): search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value. NOTE: if q param is defined this param will be ignored.
+            search_fields (str): comma separated list of fields for searching.
+            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
+            return_count (bool): Whether to return total count. default is False.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            user_id (int): Specific user. privileges required.
+            shared (bool): Whether to return shared layouts. default is False.
+
+        Returns:
+            List[Layout] | int: A list of layout instances or the total number of layouts.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layouts = Layout.get_layout(client, q="name LIKE '%My layout%'")
+            or
+            >>> layouts = client.get_layout(q="name LIKE '%My layout%'")
+        """
+        params = {
+           'f': 'json',
+           'q': kwargs.get('q'),
+           'search': kwargs.get('search'),
+           'search_fields': kwargs.get('search_fields'),
+           'order_by': kwargs.get('order_by'),
+           'return_count': kwargs.get('return_count', False),
+           'skip': kwargs.get('skip', 0),
+           'limit': kwargs.get('limit', 10),
+           'user_id': kwargs.get('user_id'),
+           'shared': kwargs.get('shared', False)
+        }
+        return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Layout(api, item['uuid'], item))
+    
+
+    @classmethod
+    def create_layout(cls, 
+                     api: 'GeoboxClient', 
+                     name: str, 
+                     display_name: str = None, 
+                     description: str = None, 
+                     settings: Dict = {}, 
+                     thumbnail: str = None, 
+                     user_id: int = None) -> 'Layout':
+        """
+        Create a new layout.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): The name of the Layout.
+            display_name (str): The display name of the layout.
+            description (str): The description of the layout.
+            settings (Dict): The settings of the layout.
+            thumbnail (str): The thumbnail of the layout.
+            user_id (int): Specific user. privileges layout.
+
+        Returns:
+            Layout: The newly created layout instance.
+
+        Raises:
+            ValidationError: If the layout data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.create_layout(client, name="my_layout")
+            or
+            >>> layout = client.create_layout(name="my_layout")
+        """
+        data = {
+            "name": name,
+            "display_name": display_name,
+            "description": description,
+            "settings": settings,
+            "thumbnail": thumbnail,
+            "user_id": user_id,
+        }
+        return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Layout(api, item['uuid'], item))
+
+    
+    @classmethod
+    def get_layout(cls, api: 'GeoboxClient', uuid: str, user_id: int = None) -> 'Layout':
+        """
+        Get a layout by its UUID.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The UUID of the layout to get.
+            user_id (int): Specific user. privileges required.
+
+        Returns:
+            Layout: The layout object.
+
+        Raises:
+            NotFoundError: If the layout with the specified UUID is not found.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>> layout = client.get_layout(uuid="12345678-1234-5678-1234-567812345678")
+        """
+        params = {
+            'f': 'json',
+            'user_id': user_id,
+        }
+        return super()._get_detail(api, cls.BASE_ENDPOINT, uuid, params, factory_func=lambda api, item: Layout(api, item['uuid'], item))
+
+
+    @classmethod
+    def get_layout_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> Union['Layout', None]:
+        """
+        Get a layout by name
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): the name of the layout to get
+            user_id (int, optional): specific user. privileges required.
+
+        Returns:
+            Layout | None: returns the layout if a layout matches the given name, else None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout_by_name(client, name='test')
+            or
+            >>> layout = client.get_layout_by_name(name='test')
+        """
+        layouts = cls.get_layouts(api, q=f"name = '{name}'", user_id=user_id)
+        if layouts and layouts[0].name == name:
+            return layouts[0]
+        else:
+            return None
+
+
+    def update(self, **kwargs) -> Dict:
+        """
+        Update the layout.
+
+        Keyword Args:
+            name (str): The name of the layout.
+            display_name (str): The display name of the layout.
+            description (str): The description of the layout.
+            settings (Dict): The settings of the layout.
+            thumbnail (str): The thumbnail of the layout.
+
+        Returns:
+            Dict: The updated layout data.
+
+        Raises:
+            ValidationError: If the layout data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layout.update_layout(display_name="New Display Name")
+        """
+        data = {
+            "name": kwargs.get('name'),
+            "display_name": kwargs.get('display_name'),   
+            "description": kwargs.get('description'),
+            "settings": kwargs.get('settings'),
+            "thumbnail": kwargs.get('thumbnail')
+        }
+        return super()._update(self.endpoint, data)
+    
+
+    def delete(self) -> None:
+        """
+        Delete the Layout.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layout.delete()
+        """
+        super().delete(self.endpoint)
+
+
+    @property
+    def thumbnail(self) -> str:
+        """
+        Get the thumbnail URL of the Layout.
+
+        Returns:
+            str: The thumbnail of the Layout.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layout.thumbnail
+            'https://example.com/thumbnail.png'
+        """
+        return super().thumbnail()
+    
+
+    def share(self, users: List['User']) -> None:
+        """
+        Shares the layout with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to share the layout with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> layout.share(users=users)
+        """
+        super()._share(self.endpoint, users)
+    
+
+    def unshare(self, users: List['User']) -> None:
+        """
+        Unshares the layout with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to unshare the layout with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> layout.unshare(users=users)
+        """
+        super()._unshare(self.endpoint, users)
+
+
+    def get_shared_users(self, search: str = None, skip: int = 0, limit: int = 10) -> List['User']:
+        """
+        Retrieves the list of users the layout is shared with.
+
+        Args:
+            search (str, optional): The search query.
+            skip (int, optional): The number of users to skip.
+            limit (int, optional): The maximum number of users to retrieve.
+
+        Returns:
+            List[User]: The list of shared users.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.layout import Layout
+            >>> client = GeoboxClient()
+            >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layout.get_shared_users(search='John', skip=0, limit=10)
+        """
+        params = {
+            'search': search,
+            'skip': skip,
+            'limit': limit
+        }
+        return super()._get_shared_users(self.endpoint, params)