geobox 1.4.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

geobox/api.py

@@ -29,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
@@ -2294,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.
@@ -2313,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/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/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/enums.py

@@ -272,14 +272,6 @@ class UserStatus(Enum):
     DISABLED = "Disabled"
 
 
-class AttachmentResourceType(Enum):
-    Map = "map"
-
-    Vector = "vector"
-
-    View = "view"
-
-
 class MaxLogPolicy(Enum):
     OverwriteFirstLog = "OverwriteFirstLog"
 

geobox/log.py

@@ -6,6 +6,7 @@ from .base import Base
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .user import User
 
 
 class Log(Base):
@@ -98,4 +99,22 @@ class Log(Base):
             >>> log.delete()
         """
         super().delete(self.endpoint)
-        self.log_id = None
+        self.log_id = None
+
+
+    @property
+    def user(self) -> Union['User', None]:
+        """
+        Get the owner user for the log
+
+        Returns:
+            User | None: if the log has owner user 
+
+        Example:
+            >>> from geobox import Geobox
+            >>> from geopox.log import Log
+            >>> client = GeoboxClient()
+            >>> log = Log.get_logs(client)[0]
+            >>> log.user
+        """
+        return self.api.get_user(self.owner_id)

geobox/map.py

@@ -4,11 +4,15 @@ from urllib.parse import urljoin, urlencode
 from .base import Base
 from .utils import clean_data, join_url_params
 from .model3d import Model
+from .file import File
+from .feature import Feature
 
 if TYPE_CHECKING:
     from . import GeoboxClient
     from .user import User
     from .task import Task
+    from .attachment import Attachment
+
 
 
 class Map(Base):
@@ -899,3 +903,80 @@ class Map(Base):
         endpoint = f"{endpoint}?{query_string}"
         response = self.api.post(endpoint)
         return self.api.get_task(response['task_id'])
+
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        Keyword Args:
+            element_id (str): the id of the element with attachment.
+            search (str): search term for keyword-based searching among all textual fields.
+            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.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            return_count (bool): Whether to return total count. default is False.
+
+        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.map import Map
+            >>> client = GeoboxClient()
+            >>> map = Map.get_map(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> map.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            name (str): The name of the scene.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+            file (File): the file object.
+            feature (Feature, optional): the feature object.
+            display_name (str, optional): The display name of the scene.
+            description (str, optional): The description of the scene.
+
+        Returns:
+            Attachment: The newly created Attachment instance.
+
+        Raises:
+            ValidationError: If the Attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.map import Map
+            >>> client = GeoboxClient()
+            >>> map = Map.get_map(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> map.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

geobox/vectorlayer.py

@@ -11,12 +11,13 @@ from .task import Task
 from .enums import InputGeomType, FileOutputFormat
 from .version import VectorLayerVersion
 
-
 if TYPE_CHECKING:
     from .api import GeoboxClient
     from .view import VectorLayerView
     from .user import User
     from .file import File
+    from .attachment import Attachment
+
 
 class VectorLayer(Base):
     """
@@ -1227,4 +1228,81 @@ class VectorLayer(Base):
             >>> layer.prune_edited_areas()
         """
         endpoint = urljoin(self.endpoint, 'prune/')
-        return self.api.post(endpoint)
+        return self.api.post(endpoint)
+    
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        Keyword Args:
+            element_id (str): the id of the element with attachment.
+            search (str): search term for keyword-based searching among all textual fields.
+            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.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            return_count (bool): Whether to return total count. default is False.
+
+        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.vectorlayer import VectorLayer
+            >>> client = GeoboxClient()
+            >>> layer = VectorLayer.get_vector(api=client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            name (str): The name of the scene.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+            file (File): the file object.
+            feature (Feature, optional): the feature object.
+            display_name (str, optional): The display name of the scene.
+            description (str, optional): The description of the scene.
+
+        Returns:
+            Attachment: The newly created Attachment instance.
+
+        Raises:
+            ValidationError: If the Attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.vectorlayer import VectorLayer
+            >>> client = GeoboxClient()
+            >>> layer = VectorLayer.get_vector(api=client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> layer.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

geobox/view.py

@@ -7,9 +7,11 @@ if TYPE_CHECKING:
     from . import GeoboxClient
     from .field import Field
     from .user import User
-    from .enums import InputGeomType, FieldType
+    from .enums import InputGeomType
     from .task import Task
     from .file import File
+    from .attachment import Attachment
+
 
 
 class VectorLayerView(VectorLayer):
@@ -862,3 +864,80 @@ class VectorLayerView(VectorLayer):
             >>> view.prune_edited_areas()
         """
         return super().prune_edited_areas()
+
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        Keyword Args:
+            element_id (str): the id of the element with attachment.
+            search (str): search term for keyword-based searching among all textual fields.
+            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.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            return_count (bool): Whether to return total count. default is False.
+
+        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.view import VectorLayerView
+            >>> client = GeoboxClient()
+            >>> view = VectorLayerView.get_view(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> view.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            name (str): The name of the scene.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+            file (File): the file object.
+            feature (Feature, optional): the feature object.
+            display_name (str, optional): The display name of the scene.
+            description (str, optional): The description of the scene.
+
+        Returns:
+            Attachment: The newly created Attachment instance.
+
+        Raises:
+            ValidationError: If the Attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.view import VectorLayerView
+            >>> client = GeoboxClient()
+            >>> view = VectorLayerView.get_view(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> view.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

{geobox-1.4.0.dist-info → geobox-1.4.1.dist-info}/METADATA

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

{geobox-1.4.0.dist-info → geobox-1.4.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
-geobox/api.py,sha256=lqVpQ_NLyPpDnySxYlSBLiZelkbL7IFd5uX3K-9QRho,105246
+geobox/api.py,sha256=8wO1AvyIWf0n2gi-Jv22IM6gyjtbX4KGBYXJTKTh01A,105230
 geobox/apikey.py,sha256=OXsf1ltXcN1jIQJHECdnIE5R_Qksb897xVJOkORRsxw,7522
-geobox/attachment.py,sha256=qplcYfHkoV9aHaXQ7xFnkrsYxwmUs0PNPbjoSerET34,11582
+geobox/attachment.py,sha256=Q5LVn2j8gm-CptDVhpqtfzyQTDDd1FjW_9MEJBRQb6M,11865
 geobox/base.py,sha256=OdabLbBflglLkNWM7TGCWtPh73M_-42_Ph963K26JQg,12931
-geobox/basemap.py,sha256=7Jo2MeEN8U8Av54kPPaFzQFjajcNYgMRMOTZXPUcXyk,4529
+geobox/basemap.py,sha256=fQhCj6ERYCEaY4RLINrftEt4RDakddKZ-wG9Av4Rv_8,4468
 geobox/dashboard.py,sha256=x99jUGzUJra4cdcffSYC0_FvrihZh6sPI4o79f-Aptc,11694
-geobox/enums.py,sha256=C7PQf8pisiRwHE7-wsgSQ_rZcpvP6-7EDpx8iXijkMs,6300
+geobox/enums.py,sha256=Ur8zbUjfx09oxXb-uzwFfDT_Nt8I4AP5pFQKJ9bxVxI,6204
 geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
 geobox/feature.py,sha256=3Kbc1LjIkBt1YqRAry84BrR7qxx9BexvBB3YQ8D9mGk,18504
 geobox/field.py,sha256=p9eitUpnsiGj6GUhjSomk6HWlsNJSbE-Oh_4VcjaqVo,10562
 geobox/file.py,sha256=cMm-SwTzRKALiIj-gkY4UJzUsOuN5SGz50eU1ylNAxk,20079
 geobox/layout.py,sha256=TdE5FJ7fzbhkexojY8h-r68hXb5UYM6MIfNkxfs_RKA,11285
-geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
-geobox/map.py,sha256=oMhpbmeRtamI1iVYZIWXgGQa3NOcKh6O57mgrDBQkno,32723
+geobox/log.py,sha256=Xuq4oKPwaypZ4nYEOIXu13dH4AkQcf0pkTw85gDQqS4,4063
+geobox/map.py,sha256=JfGYGo1P9jcbYLr3RkwrvhTTnb-xmH_EsuqO0M_yT5c,36118
 geobox/model3d.py,sha256=GUpZdRcy6Fs83PdqdfX70F_uxIAqkyTbsMWYSI7rV5k,12011
 geobox/mosaic.py,sha256=6wSK9xkjtBUEtIsZANWVYwsJbDx112mO1SQOXcPTVo8,23780
 geobox/plan.py,sha256=jUzl6CQBY6IsdieEppJOmE0sSjwvu6eHO89pC_JFs6I,12066
@@ -27,12 +27,12 @@ geobox/tileset.py,sha256=bQOckE04F31vb-NYmNsQzXndZSTDZyskWspRikjZuBs,24241
 geobox/usage.py,sha256=_54xL-n-2Bg9wGpoOBKnh85WqdpMWEtqxRJVaFlVWe0,7908
 geobox/user.py,sha256=YY72uRvjKUUWUZbxhrft37FVBlqDeosPMf3EpMVBhc0,15069
 geobox/utils.py,sha256=qLtchKIdw-az3KCiiFv0-Cpmx9RfBxORjlATvVyDIaQ,1314
-geobox/vectorlayer.py,sha256=5IglRp7uoMm3yggYpHurDRAGQo9x7KdjJGicSLpxrSs,53035
+geobox/vectorlayer.py,sha256=eB1zadgS4xqxV1NEUwaXsh5PIwAX054tYBqdu8ZO6hs,56452
 geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
-geobox/view.py,sha256=ZNJNBQclM6fc0cxXmU_L_XEBwd4lbsEncs6ynxWU9lc,37531
+geobox/view.py,sha256=t-MlTNDL1T53Mybny5UOMTjVQwDdaDovLJfyl3Qgx1I,40919
 geobox/workflow.py,sha256=_WEIy1zLpBFx5yeuZ4ClnwPdU90jQbdy5bWYYIRa4JY,11549
-geobox-1.4.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-1.4.0.dist-info/METADATA,sha256=GGoWFZt8cAf-9N_3YIEz4ZLyv77uMT0IO-kZyAj6-rQ,2658
-geobox-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-1.4.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-1.4.0.dist-info/RECORD,,
+geobox-1.4.1.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-1.4.1.dist-info/METADATA,sha256=KF1UGO6DhvFbUGt4WcubAl9QH7VAcGz1K0OMytVgaC0,2658
+geobox-1.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-1.4.1.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-1.4.1.dist-info/RECORD,,