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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
geobox/api.py CHANGED
@@ -20,6 +20,7 @@ from .map import Map
20
20
  from .user import User, UserRole, UserStatus, Session
21
21
  from .query import Query
22
22
  from .workflow import Workflow
23
+ from .layout import Layout
23
24
  from .version import VectorLayerVersion
24
25
  from .tile3d import Tile3d
25
26
  from .settings import SystemSettings
@@ -1535,7 +1536,7 @@ class GeoboxClient:
1535
1536
  Example:
1536
1537
  >>> from geobox import GeoboxClient
1537
1538
  >>> client = GeoboxClient()
1538
- >>> workflows = client.get_workflow(q="name LIKE '%My workflow%'")
1539
+ >>> workflows = client.get_workflows(q="name LIKE '%My workflow%'")
1539
1540
  """
1540
1541
  return Workflow.get_workflows(self, **kwargs)
1541
1542
 
@@ -1681,6 +1682,105 @@ class GeoboxClient:
1681
1682
  return VectorLayerVersion.get_version_by_name(self, name, user_id)
1682
1683
 
1683
1684
 
1685
+ def get_layouts(self, **kwargs) -> Union[List['Layout'], int]:
1686
+ """
1687
+ Get list of layouts with optional filtering and pagination.
1688
+
1689
+ Keyword Args:
1690
+ q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
1691
+ 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.
1692
+ search_fields (str): comma separated list of fields for searching.
1693
+ 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.
1694
+ return_count (bool): Whether to return total count. default is False.
1695
+ skip (int): Number of items to skip. default is 0.
1696
+ limit (int): Number of items to return. default is 10.
1697
+ user_id (int): Specific user. privileges required.
1698
+ shared (bool): Whether to return shared layouts. default is False.
1699
+
1700
+ Returns:
1701
+ List[Layout] | int: A list of layout instances or the total number of layouts.
1702
+
1703
+ Example:
1704
+ >>> from geobox import GeoboxClient
1705
+ >>> client = GeoboxClient()
1706
+ >>> layouts = client.get_layouts(q="name LIKE '%My layout%'")
1707
+ """
1708
+ return Layout.get_layouts(self, **kwargs)
1709
+
1710
+
1711
+ def create_layout(self,
1712
+ name: str,
1713
+ display_name: str = None,
1714
+ description: str = None,
1715
+ settings: Dict = {},
1716
+ thumbnail: str = None,
1717
+ user_id: int = None) -> 'Layout':
1718
+ """
1719
+ Create a new layout.
1720
+
1721
+ Args:
1722
+ name (str): The name of the layout.
1723
+ display_name (str): The display name of the layout.
1724
+ description (str): The description of the layout.
1725
+ settings (Dict): The settings of the layout.
1726
+ thumbnail (str): The thumbnail of the layout.
1727
+ user_id (int): Specific user. privileges layout.
1728
+
1729
+ Returns:
1730
+ Layout: The newly created layout instance.
1731
+
1732
+ Raises:
1733
+ ValidationError: If the layout data is invalid.
1734
+
1735
+ Example:
1736
+ >>> from geobox import GeoboxClient
1737
+ >>> client = GeoboxClient()
1738
+ >>> layout = client.create_layout(name="my_layout")
1739
+ """
1740
+ return Layout.create_layout(self, name, display_name, description, settings, thumbnail, user_id)
1741
+
1742
+
1743
+ def get_layout(self, uuid: str, user_id: int = None) -> 'Layout':
1744
+ """
1745
+ Get a layout by its UUID.
1746
+
1747
+ Args:
1748
+ uuid (str): The UUID of the layout to get.
1749
+ user_id (int): Specific user. privileges required.
1750
+
1751
+ Returns:
1752
+ Layout: The layout object.
1753
+
1754
+ Raises:
1755
+ NotFoundError: If the layout with the specified UUID is not found.
1756
+
1757
+ Example:
1758
+ >>> from geobox import GeoboxClient
1759
+ >>> client = GeoboxClient()
1760
+ >>> layout = client.get_layout(uuid="12345678-1234-5678-1234-567812345678")
1761
+ """
1762
+ return Layout.get_layout(self, uuid, user_id)
1763
+
1764
+
1765
+ def get_layout_by_name(self, name: str, user_id: int = None) -> Union['Layout', None]:
1766
+ """
1767
+ Get a layout by name
1768
+
1769
+ Args:
1770
+ name (str): the name of the layout to get
1771
+ user_id (int, optional): specific user. privileges required.
1772
+
1773
+ Returns:
1774
+ Layout | None: returns the layout if a layout matches the given name, else None
1775
+
1776
+ Example:
1777
+ >>> from geobox import GeoboxClient
1778
+ >>> client = GeoboxClient()
1779
+ >>> layout = client.get_layout_by_name(name='test')
1780
+ """
1781
+ return Layout.get_layout_by_name(self, name, user_id)
1782
+
1783
+
1684
1784
  def get_3dtiles(self, **kwargs) -> Union[List['Tile3d'], int]:
1685
1785
  """
1686
1786
  Get list of 3D Tiles with optional filtering and pagination.
@@ -2016,6 +2116,25 @@ class GeoboxClient:
2016
2116
  return Plan.get_plan(self, plan_id)
2017
2117
 
2018
2118
 
2119
+ def get_plan_by_name(self, name: str) -> Union['Plan', None]:
2120
+ """
2121
+ Get a plan by name
2122
+
2123
+ Args:
2124
+ api (GeoboxClient): The GeoboxClient instance for making requests.
2125
+ name (str): the name of the plan to get
2126
+
2127
+ Returns:
2128
+ Plan | None: returns the plan if a plan matches the given name, else None
2129
+
2130
+ Example:
2131
+ >>> from geobox import GeoboxClient
2132
+ >>> client = GeoboxClient()
2133
+ >>> plan = client.get_plan_by_name(name='test')
2134
+ """
2135
+ return Plan.get_plan_by_name(self, name)
2136
+
2137
+
2019
2138
  def get_dashboards(self, **kwargs) -> Union[List['Dashboard'], int]:
2020
2139
  """
2021
2140
  Get list of Dashboards
geobox/apikey.py CHANGED
@@ -176,11 +176,14 @@ class ApiKey(Base):
176
176
  >>> apikey = ApiKey.get_apikey(client, key_id=1)
177
177
  >>> apikey.update(name="updated_name")
178
178
  """
179
- data = {
179
+ data = clean_data({
180
180
  "name": name,
181
181
  "user_id": user_id
182
- }
183
- return super()._update(self.endpoint, data)
182
+ })
183
+
184
+ response = self.api.put(self.endpoint, data, is_json=False)
185
+ self._update_properties(response)
186
+ return response
184
187
 
185
188
 
186
189
  def delete(self) -> None:
geobox/enums.py CHANGED
@@ -19,6 +19,7 @@ class PublishFileType(Enum):
19
19
  VECTOR = 'vector'
20
20
  RASTER = 'raster'
21
21
  MODEL3D = 'model3d'
22
+ Tiles3D = 'tiles3d'
22
23
 
23
24
  class FileType(Enum):
24
25
  Compressed = 'Compressed'
@@ -36,6 +37,7 @@ class FileType(Enum):
36
37
  FileGDB = 'FileGDB'
37
38
  GeoTIFF = 'GeoTIFF'
38
39
  GeoJSON = 'GeoJSON'
40
+ ThreedTiles = 'ThreedTiles'
39
41
 
40
42
  class FileFormat(Enum):
41
43
  # Spatial Data Formats
geobox/file.py CHANGED
@@ -429,6 +429,9 @@ class File(Base):
429
429
  FileType(self.layers[0]['format']).value in ['GLB']):
430
430
  publish_as = PublishFileType.MODEL3D
431
431
 
432
+ elif self.file_type.value in ['ThreedTiles']:
433
+ publish_as = PublishFileType.Tiles3D
434
+
432
435
  else:
433
436
  raise ValidationError('Unknown format')
434
437
 
geobox/layout.py ADDED
@@ -0,0 +1,314 @@
1
+ from typing import List, Dict, Optional, TYPE_CHECKING, Union
2
+
3
+ from .base import Base
4
+
5
+ if TYPE_CHECKING:
6
+ from . import GeoboxClient
7
+ from .user import User
8
+
9
+ class Layout(Base):
10
+
11
+ BASE_ENDPOINT = 'layouts/'
12
+
13
+ def __init__(self,
14
+ api: 'GeoboxClient',
15
+ uuid: str,
16
+ data: Optional[Dict] = {}):
17
+ """
18
+ Initialize a layout instance.
19
+
20
+ Args:
21
+ api (GeoboxClient): The GeoboxClient instance for making requests.
22
+ uuid (str): The unique identifier for the layout.
23
+ data (Dict): The data of the layout.
24
+ """
25
+ super().__init__(api, uuid=uuid, data=data)
26
+
27
+
28
+ @classmethod
29
+ def get_layouts(cls, api: 'GeoboxClient', **kwargs) -> Union[List['Layout'], int]:
30
+ """
31
+ Get list of layouts with optional filtering and pagination.
32
+
33
+ Args:
34
+ api (GeoboxClient): The GeoboxClient instance for making requests.
35
+
36
+ Keyword Args:
37
+ q (str): query filter based on OGC CQL standard. e.g. "field1 LIKE '%GIS%' AND created_at > '2021-01-01'"
38
+ 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.
39
+ search_fields (str): comma separated list of fields for searching.
40
+ 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.
41
+ return_count (bool): Whether to return total count. default is False.
42
+ skip (int): Number of items to skip. default is 0.
43
+ limit (int): Number of items to return. default is 10.
44
+ user_id (int): Specific user. privileges required.
45
+ shared (bool): Whether to return shared layouts. default is False.
46
+
47
+ Returns:
48
+ List[Layout] | int: A list of layout instances or the total number of layouts.
49
+
50
+ Example:
51
+ >>> from geobox import GeoboxClient
52
+ >>> from geobox.layout import Layout
53
+ >>> client = GeoboxClient()
54
+ >>> layouts = Layout.get_layout(client, q="name LIKE '%My layout%'")
55
+ or
56
+ >>> layouts = client.get_layout(q="name LIKE '%My layout%'")
57
+ """
58
+ params = {
59
+ 'f': 'json',
60
+ 'q': kwargs.get('q'),
61
+ 'search': kwargs.get('search'),
62
+ 'search_fields': kwargs.get('search_fields'),
63
+ 'order_by': kwargs.get('order_by'),
64
+ 'return_count': kwargs.get('return_count', False),
65
+ 'skip': kwargs.get('skip', 0),
66
+ 'limit': kwargs.get('limit', 10),
67
+ 'user_id': kwargs.get('user_id'),
68
+ 'shared': kwargs.get('shared', False)
69
+ }
70
+ return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Layout(api, item['uuid'], item))
71
+
72
+
73
+ @classmethod
74
+ def create_layout(cls,
75
+ api: 'GeoboxClient',
76
+ name: str,
77
+ display_name: str = None,
78
+ description: str = None,
79
+ settings: Dict = {},
80
+ thumbnail: str = None,
81
+ user_id: int = None) -> 'Layout':
82
+ """
83
+ Create a new layout.
84
+
85
+ Args:
86
+ api (GeoboxClient): The GeoboxClient instance for making requests.
87
+ name (str): The name of the Layout.
88
+ display_name (str): The display name of the layout.
89
+ description (str): The description of the layout.
90
+ settings (Dict): The settings of the layout.
91
+ thumbnail (str): The thumbnail of the layout.
92
+ user_id (int): Specific user. privileges layout.
93
+
94
+ Returns:
95
+ Layout: The newly created layout instance.
96
+
97
+ Raises:
98
+ ValidationError: If the layout data is invalid.
99
+
100
+ Example:
101
+ >>> from geobox import GeoboxClient
102
+ >>> from geobox.layout import Layout
103
+ >>> client = GeoboxClient()
104
+ >>> layout = Layout.create_layout(client, name="my_layout")
105
+ or
106
+ >>> layout = client.create_layout(name="my_layout")
107
+ """
108
+ data = {
109
+ "name": name,
110
+ "display_name": display_name,
111
+ "description": description,
112
+ "settings": settings,
113
+ "thumbnail": thumbnail,
114
+ "user_id": user_id,
115
+ }
116
+ return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Layout(api, item['uuid'], item))
117
+
118
+
119
+ @classmethod
120
+ def get_layout(cls, api: 'GeoboxClient', uuid: str, user_id: int = None) -> 'Layout':
121
+ """
122
+ Get a layout by its UUID.
123
+
124
+ Args:
125
+ api (GeoboxClient): The GeoboxClient instance for making requests.
126
+ uuid (str): The UUID of the layout to get.
127
+ user_id (int): Specific user. privileges required.
128
+
129
+ Returns:
130
+ Layout: The layout object.
131
+
132
+ Raises:
133
+ NotFoundError: If the layout with the specified UUID is not found.
134
+
135
+ Example:
136
+ >>> from geobox import GeoboxClient
137
+ >>> from geobox.layout import Layout
138
+ >>> client = GeoboxClient()
139
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
140
+ or
141
+ >>> layout = client.get_layout(uuid="12345678-1234-5678-1234-567812345678")
142
+ """
143
+ params = {
144
+ 'f': 'json',
145
+ 'user_id': user_id,
146
+ }
147
+ return super()._get_detail(api, cls.BASE_ENDPOINT, uuid, params, factory_func=lambda api, item: Layout(api, item['uuid'], item))
148
+
149
+
150
+ @classmethod
151
+ def get_layout_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> Union['Layout', None]:
152
+ """
153
+ Get a layout by name
154
+
155
+ Args:
156
+ api (GeoboxClient): The GeoboxClient instance for making requests.
157
+ name (str): the name of the layout to get
158
+ user_id (int, optional): specific user. privileges required.
159
+
160
+ Returns:
161
+ Layout | None: returns the layout if a layout matches the given name, else None
162
+
163
+ Example:
164
+ >>> from geobox import GeoboxClient
165
+ >>> from geobox.layout import Layout
166
+ >>> client = GeoboxClient()
167
+ >>> layout = Layout.get_layout_by_name(client, name='test')
168
+ or
169
+ >>> layout = client.get_layout_by_name(name='test')
170
+ """
171
+ layouts = cls.get_layouts(api, q=f"name = '{name}'", user_id=user_id)
172
+ if layouts and layouts[0].name == name:
173
+ return layouts[0]
174
+ else:
175
+ return None
176
+
177
+
178
+ def update(self, **kwargs) -> Dict:
179
+ """
180
+ Update the layout.
181
+
182
+ Keyword Args:
183
+ name (str): The name of the layout.
184
+ display_name (str): The display name of the layout.
185
+ description (str): The description of the layout.
186
+ settings (Dict): The settings of the layout.
187
+ thumbnail (str): The thumbnail of the layout.
188
+
189
+ Returns:
190
+ Dict: The updated layout data.
191
+
192
+ Raises:
193
+ ValidationError: If the layout data is invalid.
194
+
195
+ Example:
196
+ >>> from geobox import GeoboxClient
197
+ >>> from geobox.layout import Layout
198
+ >>> client = GeoboxClient()
199
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
200
+ >>> layout.update_layout(display_name="New Display Name")
201
+ """
202
+ data = {
203
+ "name": kwargs.get('name'),
204
+ "display_name": kwargs.get('display_name'),
205
+ "description": kwargs.get('description'),
206
+ "settings": kwargs.get('settings'),
207
+ "thumbnail": kwargs.get('thumbnail')
208
+ }
209
+ return super()._update(self.endpoint, data)
210
+
211
+
212
+ def delete(self) -> None:
213
+ """
214
+ Delete the Layout.
215
+
216
+ Returns:
217
+ None
218
+
219
+ Example:
220
+ >>> from geobox import GeoboxClient
221
+ >>> from geobox.layout import Layout
222
+ >>> client = GeoboxClient()
223
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
224
+ >>> layout.delete()
225
+ """
226
+ super().delete(self.endpoint)
227
+
228
+
229
+ @property
230
+ def thumbnail(self) -> str:
231
+ """
232
+ Get the thumbnail URL of the Layout.
233
+
234
+ Returns:
235
+ str: The thumbnail of the Layout.
236
+
237
+ Example:
238
+ >>> from geobox import GeoboxClient
239
+ >>> from geobox.layout import Layout
240
+ >>> client = GeoboxClient()
241
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
242
+ >>> layout.thumbnail
243
+ 'https://example.com/thumbnail.png'
244
+ """
245
+ return super().thumbnail()
246
+
247
+
248
+ def share(self, users: List['User']) -> None:
249
+ """
250
+ Shares the layout with specified users.
251
+
252
+ Args:
253
+ users (List[User]): The list of user objects to share the layout with.
254
+
255
+ Returns:
256
+ None
257
+
258
+ Example:
259
+ >>> from geobox import GeoboxClient
260
+ >>> from geobox.layout import Layout
261
+ >>> client = GeoboxClient()
262
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
263
+ >>> users = client.search_users(search='John')
264
+ >>> layout.share(users=users)
265
+ """
266
+ super()._share(self.endpoint, users)
267
+
268
+
269
+ def unshare(self, users: List['User']) -> None:
270
+ """
271
+ Unshares the layout with specified users.
272
+
273
+ Args:
274
+ users (List[User]): The list of user objects to unshare the layout with.
275
+
276
+ Returns:
277
+ None
278
+
279
+ Example:
280
+ >>> from geobox import GeoboxClient
281
+ >>> from geobox.layout import Layout
282
+ >>> client = GeoboxClient()
283
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
284
+ >>> users = client.search_users(search='John')
285
+ >>> layout.unshare(users=users)
286
+ """
287
+ super()._unshare(self.endpoint, users)
288
+
289
+
290
+ def get_shared_users(self, search: str = None, skip: int = 0, limit: int = 10) -> List['User']:
291
+ """
292
+ Retrieves the list of users the layout is shared with.
293
+
294
+ Args:
295
+ search (str, optional): The search query.
296
+ skip (int, optional): The number of users to skip.
297
+ limit (int, optional): The maximum number of users to retrieve.
298
+
299
+ Returns:
300
+ List[User]: The list of shared users.
301
+
302
+ Example:
303
+ >>> from geobox import GeoboxClient
304
+ >>> from geobox.layout import Layout
305
+ >>> client = GeoboxClient()
306
+ >>> layout = Layout.get_layout(client, uuid="12345678-1234-5678-1234-567812345678")
307
+ >>> layout.get_shared_users(search='John', skip=0, limit=10)
308
+ """
309
+ params = {
310
+ 'search': search,
311
+ 'skip': skip,
312
+ 'limit': limit
313
+ }
314
+ return super()._get_shared_users(self.endpoint, params)
geobox/map.py CHANGED
@@ -859,4 +859,43 @@ class Map(Base):
859
859
  >>> map.image_tile_url()
860
860
  >>> map.image_tile_url(x=1, y=2, z=3, format='.pbf')
861
861
  """
862
- return f"{self.BASE_ENDPOINT}{self.endpoint}{z}/{x}/{y}{format}"
862
+ endpoint = f"{self.api.base_url}{self.endpoint}tiles/{z}/{x}/{y}{format}"
863
+
864
+ if not self.api.access_token and self.api.apikey:
865
+ endpoint = f'{endpoint}?apikey={self.api.apikey}'
866
+
867
+ return endpoint
868
+
869
+
870
+ def export_map_to_image(self, bbox: List, width: int, height: int) -> 'Task':
871
+ """
872
+ Export the map to image
873
+
874
+ Args:
875
+ bbox (List): e.g. [50.275, 35.1195, 51.4459, 36.0416]
876
+ width (int): minimum: 10, maximum: 10000
877
+ height (int): minimum: 10, maximum: 10000
878
+
879
+ Returns:
880
+ Task: the task object
881
+
882
+ Example:
883
+ >>> from geobox import GeoboxClient
884
+ >>> from geobox.map import Map
885
+ >>> client = GeoboxClient()
886
+ >>> map = Map.get_map(client, uuid="12345678-1234-5678-1234-567812345678")
887
+ >>> task = map.export_map_to_image(bbox=[50.275, 35.1195, 51.4459, 36.0416],
888
+ ... width=1024,
889
+ ... height=1024)
890
+ """
891
+ data = clean_data({
892
+ 'uuid': self.uuid,
893
+ 'bbox': bbox,
894
+ 'width': width,
895
+ 'height': height
896
+ })
897
+ query_string = urlencode(data)
898
+ endpoint = urljoin(self.endpoint, 'export/')
899
+ endpoint = f"{endpoint}?{query_string}"
900
+ response = self.api.post(endpoint)
901
+ return self.api.get_task(response['task_id'])
geobox/model3d.py CHANGED
@@ -152,6 +152,7 @@ class Model(Base):
152
152
 
153
153
  Keyword Args:
154
154
  name (str): The new name for the model.
155
+ display_name (str): The new display name.
155
156
  description (str): The new description for the model.
156
157
  settings (Dict): The new settings for the model.
157
158
  thumbnail (str): The new thumbnail for the model.
@@ -190,6 +191,7 @@ class Model(Base):
190
191
  """
191
192
  data = {
192
193
  'name': kwargs.get('name'),
194
+ 'display_name': kwargs.get('display_name'),
193
195
  'description': kwargs.get('description'),
194
196
  'settings': kwargs.get('settings'),
195
197
  'thumbnail': kwargs.get('thumbnail')
geobox/plan.py CHANGED
@@ -191,6 +191,33 @@ class Plan(Base):
191
191
  'f': 'json'
192
192
  }
193
193
  return super()._get_detail(api, cls.BASE_ENDPOINT, plan_id, params, factory_func=lambda api, item: Plan(api, item['id'], item))
194
+
195
+
196
+ @classmethod
197
+ def get_plan_by_name(cls, api: 'GeoboxClient', name: str) -> Union['Plan', None]:
198
+ """
199
+ Get a plan by name
200
+
201
+ Args:
202
+ api (GeoboxClient): The GeoboxClient instance for making requests.
203
+ name (str): the name of the plan to get
204
+
205
+ Returns:
206
+ Plan | None: returns the plan if a plan matches the given name, else None
207
+
208
+ Example:
209
+ >>> from geobox import GeoboxClient
210
+ >>> from geobox.plan import Plan
211
+ >>> client = GeoboxClient()
212
+ >>> plan = Workflow.get_plan_by_name(client, name='test')
213
+ or
214
+ >>> plan = client.get_plan_by_name(name='test')
215
+ """
216
+ plans = cls.get_plans(api, q=f"name = '{name}'")
217
+ if plans and plans[0].name == name:
218
+ return plans[0]
219
+ else:
220
+ return None
194
221
 
195
222
 
196
223
  def update(self, **kwargs) -> Dict:
geobox/raster.py CHANGED
@@ -513,6 +513,10 @@ class Raster(Base):
513
513
  endpoint = f'{self.api.base_url}{self.endpoint}render/{z}/{x}/{y}.png'
514
514
  if query_string:
515
515
  endpoint = f'{endpoint}?{query_string}'
516
+
517
+ if not self.api.access_token and self.api.apikey:
518
+ endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
519
+
516
520
  return endpoint
517
521
 
518
522
 
geobox/task.py CHANGED
@@ -11,6 +11,7 @@ if TYPE_CHECKING:
11
11
  from .raster import Raster
12
12
  from .model3d import Model
13
13
  from .file import File
14
+ from .tile3d import Tile3d
14
15
 
15
16
  class Task(Base):
16
17
  """
@@ -46,12 +47,12 @@ class Task(Base):
46
47
 
47
48
 
48
49
  @property
49
- def output_asset(self) -> Union['VectorLayer', 'Raster', 'Model', 'File', None]:
50
+ def output_asset(self) -> Union['VectorLayer', 'Raster', 'Model', 'File', 'Tile3d', None]:
50
51
  """
51
52
  output asset property
52
53
 
53
54
  Returns:
54
- VectorLayer | Raster | Model | None: if task type is publish, it returns the published layer
55
+ VectorLayer | Raster | Model | Tile3d | None: if task type is publish, it returns the published layer
55
56
 
56
57
  Example:
57
58
  >>> from geobox import GeoboxClient
@@ -71,6 +72,9 @@ class Task(Base):
71
72
 
72
73
  elif self.data.get('result', {}).get('file_uuid'):
73
74
  return self.api.get_file(uuid=self.data['result']['file_uuid'])
75
+
76
+ elif self.data.get('result', {}).get('3dtiles_uuid'):
77
+ return self.api.get_3dtile(uuid=self.data['result']['3dtiles_uuid'])
74
78
 
75
79
  else:
76
80
  return None
geobox/tile3d.py CHANGED
@@ -1,4 +1,5 @@
1
1
  from typing import List, Dict, Optional, TYPE_CHECKING, Union
2
+ from urllib.parse import urljoin
2
3
 
3
4
  from .base import Base
4
5
 
@@ -291,4 +292,22 @@ class Tile3d(Base):
291
292
  'skip': skip,
292
293
  'limit': limit
293
294
  }
294
- return super()._get_shared_users(self.endpoint, params)
295
+ return super()._get_shared_users(self.endpoint, params)
296
+
297
+
298
+ def get_tileset_json(self) -> Dict:
299
+ """
300
+ Get Tileset JSON of a 3D Tiles.
301
+
302
+ Returns:
303
+ Dict: The tileset JSON configuration.
304
+
305
+ Example:
306
+ >>> from geobox import GeoboxClient
307
+ >>> from geobox.tile3d import Tile3d
308
+ >>> client = GeoboxClient()
309
+ >>> tile = Tile3d.get_3dtile(api=client, uuid="12345678-1234-5678-1234-567812345678")
310
+ >>> tile_json = tile.get_tileset_json()
311
+ """
312
+ endpoint = urljoin(self.endpoint, 'tileset.json')
313
+ return self.api.get(endpoint)
geobox/workflow.py CHANGED
@@ -51,9 +51,9 @@ class Workflow(Base):
51
51
  >>> from geobox import GeoboxClient
52
52
  >>> from geobox.workflow import Workflow
53
53
  >>> client = GeoboxClient()
54
- >>> workflows = Workflow.get_workflow(client, q="name LIKE '%My workflow%'")
54
+ >>> workflows = Workflow.get_workflows(client, q="name LIKE '%My workflow%'")
55
55
  or
56
- >>> workflows = client.get_workflow(q="name LIKE '%My workflow%'")
56
+ >>> workflows = client.get_workflows(q="name LIKE '%My workflow%'")
57
57
  """
58
58
  params = {
59
59
  'f': 'json',
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: geobox
3
- Version: 1.3.4
3
+ Version: 1.4.0
4
4
  Summary: SDK for Geobox's APIs
5
5
  Author-email: Hamid Heydari <heydari.h62@gmail.com>
6
6
  License: MIT
@@ -1,27 +1,28 @@
1
1
  geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
2
- geobox/api.py,sha256=spbIWSeYCml_rmiisDLQjFcvm6I_UJGobUJm9H-Z9sQ,100719
3
- geobox/apikey.py,sha256=FBio1PtGovAUaTE0HW9IJ55UuFdR_1ICk_FQhHu5dAE,7427
2
+ geobox/api.py,sha256=lqVpQ_NLyPpDnySxYlSBLiZelkbL7IFd5uX3K-9QRho,105246
3
+ geobox/apikey.py,sha256=OXsf1ltXcN1jIQJHECdnIE5R_Qksb897xVJOkORRsxw,7522
4
4
  geobox/attachment.py,sha256=qplcYfHkoV9aHaXQ7xFnkrsYxwmUs0PNPbjoSerET34,11582
5
5
  geobox/base.py,sha256=OdabLbBflglLkNWM7TGCWtPh73M_-42_Ph963K26JQg,12931
6
6
  geobox/basemap.py,sha256=7Jo2MeEN8U8Av54kPPaFzQFjajcNYgMRMOTZXPUcXyk,4529
7
7
  geobox/dashboard.py,sha256=x99jUGzUJra4cdcffSYC0_FvrihZh6sPI4o79f-Aptc,11694
8
- geobox/enums.py,sha256=mGF6eXQlNHcUXV0AVMolI200a__g-S9wMjQ1p4ka28g,6244
8
+ geobox/enums.py,sha256=C7PQf8pisiRwHE7-wsgSQ_rZcpvP6-7EDpx8iXijkMs,6300
9
9
  geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
10
10
  geobox/feature.py,sha256=3Kbc1LjIkBt1YqRAry84BrR7qxx9BexvBB3YQ8D9mGk,18504
11
11
  geobox/field.py,sha256=p9eitUpnsiGj6GUhjSomk6HWlsNJSbE-Oh_4VcjaqVo,10562
12
- geobox/file.py,sha256=Ula8r8pZaCmifsnUHDbaJujw53SLxUiCiBzVS358o88,19967
12
+ geobox/file.py,sha256=cMm-SwTzRKALiIj-gkY4UJzUsOuN5SGz50eU1ylNAxk,20079
13
+ geobox/layout.py,sha256=TdE5FJ7fzbhkexojY8h-r68hXb5UYM6MIfNkxfs_RKA,11285
13
14
  geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
14
- geobox/map.py,sha256=6pyD4rpw-Z9DIuvVg66UCBsPk30eCt0b1cIjVBxA_1Q,31348
15
- geobox/model3d.py,sha256=8P7_Yj1JvumCHWqMxgUmIvQvsKs5tSjI1vf00AItyHQ,11901
15
+ geobox/map.py,sha256=oMhpbmeRtamI1iVYZIWXgGQa3NOcKh6O57mgrDBQkno,32723
16
+ geobox/model3d.py,sha256=GUpZdRcy6Fs83PdqdfX70F_uxIAqkyTbsMWYSI7rV5k,12011
16
17
  geobox/mosaic.py,sha256=6wSK9xkjtBUEtIsZANWVYwsJbDx112mO1SQOXcPTVo8,23780
17
- geobox/plan.py,sha256=_ZV9F6loG92uQZGJl_9T08Kg85g3hnODmpccSkTYVdw,11193
18
+ geobox/plan.py,sha256=jUzl6CQBY6IsdieEppJOmE0sSjwvu6eHO89pC_JFs6I,12066
18
19
  geobox/query.py,sha256=FqeiZf2E4tJ2FG-mIfRKov6H1QWUrMSErVpNWcb3Wx0,24038
19
- geobox/raster.py,sha256=Gt2bHb8NYm-8JkJlFm4-VccihcfZQzhQA8hPc3xzfvI,29934
20
+ geobox/raster.py,sha256=gBWZUm88uJwjgSlp7auS0nEB9KjkTv1F9hvdPaJqCic,30084
20
21
  geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
21
22
  geobox/scene.py,sha256=GEzvWB-l-xO-8IodwFAPt4T7lZxuzEKJ1H0cqfx78W4,11301
22
23
  geobox/settings.py,sha256=rGRdM18Vo7xnjfZXPLRMbKeoVC_lZmzkNRPS0SQv05o,5660
23
- geobox/task.py,sha256=eLMgbhcYTADooWqKDPh6Jlh5S5oqxMMKoYIm0YPVZvg,13519
24
- geobox/tile3d.py,sha256=5z6zOihHiwCDizP_9Zwsm87gkTMljm9rQ8hFpAUkA10,10398
24
+ geobox/task.py,sha256=eqT73YC2JV9LOnQdsW5BkGsZvOl4pKYPlAtz1MxoT1c,13721
25
+ geobox/tile3d.py,sha256=BCchPCRYdvJoufYZa-I-uwVj6XREaQaYBWAqoizDUDs,11019
25
26
  geobox/tileset.py,sha256=bQOckE04F31vb-NYmNsQzXndZSTDZyskWspRikjZuBs,24241
26
27
  geobox/usage.py,sha256=_54xL-n-2Bg9wGpoOBKnh85WqdpMWEtqxRJVaFlVWe0,7908
27
28
  geobox/user.py,sha256=YY72uRvjKUUWUZbxhrft37FVBlqDeosPMf3EpMVBhc0,15069
@@ -29,9 +30,9 @@ geobox/utils.py,sha256=qLtchKIdw-az3KCiiFv0-Cpmx9RfBxORjlATvVyDIaQ,1314
29
30
  geobox/vectorlayer.py,sha256=5IglRp7uoMm3yggYpHurDRAGQo9x7KdjJGicSLpxrSs,53035
30
31
  geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
31
32
  geobox/view.py,sha256=ZNJNBQclM6fc0cxXmU_L_XEBwd4lbsEncs6ynxWU9lc,37531
32
- geobox/workflow.py,sha256=7Ne_42-nG88_Po-OAK0ChWkfrknxJiPW6JFiElTwh3Q,11547
33
- geobox-1.3.4.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
34
- geobox-1.3.4.dist-info/METADATA,sha256=r4Bk6des4BDQI3KU3Kmt1rFhXQGSkYwiOVCgGRMvPPI,2658
35
- geobox-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
36
- geobox-1.3.4.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
37
- geobox-1.3.4.dist-info/RECORD,,
33
+ geobox/workflow.py,sha256=_WEIy1zLpBFx5yeuZ4ClnwPdU90jQbdy5bWYYIRa4JY,11549
34
+ geobox-1.4.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
35
+ geobox-1.4.0.dist-info/METADATA,sha256=GGoWFZt8cAf-9N_3YIEz4ZLyv77uMT0IO-kZyAj6-rQ,2658
36
+ geobox-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
37
+ geobox-1.4.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
38
+ geobox-1.4.0.dist-info/RECORD,,
File without changes