geobox 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

geobox/api.py

@@ -597,23 +597,23 @@ class GeoboxClient:
         return File.get_file(self, uuid=uuid)
     
 
-    def get_file_by_name(self, name: str, user_id: int = None) -> Union['File', None]:
+    def get_files_by_name(self, name: str, user_id: int = None) -> List['File']:
         """
-        Get a file by name
+        Get files by name
 
         Args:
             name (str): the name of the file to get
             user_id (int, optional): specific user. privileges required.
 
         Returns:
-            File | None: returns the file if a file matches the given name, else None
+            List[File]: returns files that matches the given name
 
         Example:
             >>> from geobox import GeoboxClient
             >>> client = GeoboxClient()
-            >>> file = client.get_file_by_name(name='test')
+            >>> files = client.get_files_by_name(name='test')
         """
-        return File.get_file_by_name(self, name, user_id)
+        return File.get_files_by_name(self, name, user_id)
 
 
     def upload_file(self, path: str, user_id: int = None, scan_archive: bool = True) -> 'File':

geobox/enums.py

@@ -21,6 +21,20 @@ class PublishFileType(Enum):
     MODEL3D = 'model3d'
 
 class FileType(Enum):
+    Compressed = 'Compressed'
+    Complex = 'Complex'
+    Image = 'Image'
+    Video = 'Video'
+    Document = 'Document'
+    GPKG = 'GPKG'
+    DXF = 'DXF'
+    Shapefile = 'Shapefile'
+    KML = 'KML'
+    GLB = 'GLB'
+    FileGDB = 'FileGDB'
+    GeoTIFF = 'GeoTIFF'
+
+class FileFormat(Enum):
     # Spatial Data Formats
     Shapefile = '.shp'
     FileGDB = '.gdb'
@@ -30,7 +44,7 @@ class FileType(Enum):
     GPX = '.gpx'
     GPKG = '.gpkg'
     GeoJSON = '.geojson'
-    GeoTIFF = '.tif'
+    # GeoTIFF = '.tiff'
 
     # Image Formats
     JPG = '.jpg'

geobox/file.py

@@ -6,7 +6,7 @@ import requests
 import sys
 
 from .base import Base
-from .enums import FileType, PublishFileType, InputGeomType
+from .enums import FileFormat, PublishFileType, InputGeomType, FileType
 from .utils import clean_data
 from .task import Task
 
@@ -46,7 +46,7 @@ class File(Base):
         Returns:
             str: A string representation of the File object.
         """
-        return f"File(uuid={self.uuid}, file_name={self.name}, file_type={self.file_type})"
+        return f"File(uuid={self.uuid}, file_name={self.name}, file_type={self.file_type.value})"
 
 
     @property
@@ -66,6 +66,23 @@ class File(Base):
         return self.data.get('layers', {}).get('layers', [])
 
 
+    @property
+    def file_type(self) -> 'FileType':
+        """
+        Get the file type
+
+        Returns:
+            FileType: the file type enumeration
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> file = File.get_file(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file.file_type
+        """
+        return FileType(self.data.get('file_type'))
+
+
     @classmethod
     def upload_file(cls, api: 'GeoboxClient', path: str, user_id: int = None, scan_archive: bool = True) -> 'File':
         """
@@ -97,7 +114,7 @@ class File(Base):
             raise FileNotFoundError(f"File not found: {path}")
 
         # Check if the file type is valid
-        FileType(os.path.splitext(path)[1])
+        FileFormat(os.path.splitext(path)[1])
 
         data = clean_data({
             "user_id": user_id,
@@ -188,9 +205,9 @@ class File(Base):
 
 
     @classmethod
-    def get_file_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> Union['File', None]:
+    def get_files_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> List['File']:
         """
-        Get a file by name
+        Get files by name
 
         Args:
             api (GeoboxClient): The GeoboxClient instance for making requests.
@@ -198,21 +215,17 @@ class File(Base):
             user_id (int, optional): specific user. privileges required.
 
         Returns:
-            File | None: returns the file if a file matches the given name, else None
+            List[File]: returns files that matches the given name
 
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.file import File
             >>> client = GeoboxClient()
-            >>> file = File.get_file_by_name(client, name='test')
+            >>> files = File.get_file_by_name(client, name='test')
             or
-            >>> file = client.get_file_by_name(name='test')
+            >>> files = client.get_file_by_name(name='test')
         """
-        files = cls.get_files(api, q=f"name = '{name}'", user_id=user_id)
-        if files and files[0].name == name:
-            return files[0]
-        else:
-            return None
+        return cls.get_files(api, q=f"name = '{name}'", user_id=user_id)
     
 
     def _get_save_path(self, save_path: str = None) -> str:
@@ -359,8 +372,8 @@ class File(Base):
 
 
     def publish(self, 
-                    publish_as: 'PublishFileType', 
                     name: str, 
+                    publish_as: 'PublishFileType' = None, 
                     input_geom_type: 'InputGeomType' = None, 
                     input_layer: str = None, 
                     input_dataset: str = None, 
@@ -374,8 +387,8 @@ class File(Base):
         Publishes a file as a layer.
 
         Args:
-            publish_as (PublishFileType): The type of layer to publish as.
             name (str): The name of the layer.
+            publish_as (PublishFileType): The type of layer to publish as.
             input_geom_type (InputGeomType, optional): The geometry type of the layer.
             input_layer (str, optional): The name of the input layer.
             input_dataset (str, optional): The name of the input dataset.
@@ -405,6 +418,14 @@ class File(Base):
             ...                     input_srid=4326, 
             ...                     file_encoding='utf-8')
         """
+        if not publish_as:
+            if self.file_type.value in ['GeoJSON', 'GPKG', 'DXF', 'GPX', 'Shapefile', 'KML', 'CSV', 'FileGDB']:
+                publish_as = PublishFileType.VECTOR
+            elif self.file_type.value in ['GeoTIFF']:
+                publish_as = PublishFileType.RASTER
+            elif self.file_type.value in ['GLB']:
+                publish_as = PublishFileType.MODEL3D
+
         data = clean_data({
             "publish_as": publish_as.value if isinstance(publish_as, PublishFileType) else publish_as,
             "layer_name": name,

{geobox-1.1.0.dist-info → geobox-1.2.0.dist-info}/METADATA

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

{geobox-1.1.0.dist-info → geobox-1.2.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
 geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
-geobox/api.py,sha256=sLnq3B15UCgit_3PMMxKDnTI7hG7QykZK0uliu6Gu3A,100562
+geobox/api.py,sha256=Sq9iKYltgdR96cA4w5_5jMraNqAUpgSzMriO9PbZFNA,100538
 geobox/apikey.py,sha256=FBio1PtGovAUaTE0HW9IJ55UuFdR_1ICk_FQhHu5dAE,7427
 geobox/attachment.py,sha256=XbGwfWWuFAMimj4tsjKBvlSLP-rhpNACCtxgRmUvcdY,11631
 geobox/base.py,sha256=p0UVZo9CINw0mW9o0nNR_VNCk7V1r-FrLQ_NH39WARE,12299
 geobox/basemap.py,sha256=fDWwkMf-F2NTE1tVLijoxQku55825b6gj8nk69TMOII,4386
 geobox/dashboard.py,sha256=MYyT3YJEGPCbTXHcYoZmn14rFOaut1J3idEA8bCdFgI,11762
-geobox/enums.py,sha256=sNBtHlpCs7jIqIsLrdNtyThVZ2Mbsx_Cj7oxI1U5G5w,6267
+geobox/enums.py,sha256=0p8gbyrnT-HCwYmSZw2MreB-_UhccXqpVY-iOI97Llc,6557
 geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
 geobox/feature.py,sha256=3Kbc1LjIkBt1YqRAry84BrR7qxx9BexvBB3YQ8D9mGk,18504
 geobox/field.py,sha256=2VxjeYgRwnDxHYpAsK0ASOCz8V0JmfTA3GqHDv3rfgQ,10526
-geobox/file.py,sha256=4nlvQ6FBqOJ4WpsZYs5QnAq8hZfcD_f9KOaUFluhoxs,18610
+geobox/file.py,sha256=NqN9EoSGMiTev5vo_1QKciofcyoXonLoZz7B8hH_igk,19352
 geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
 geobox/map.py,sha256=98P1gbB5U_eu71Hu6EQ0kL_ponbPAnoOCitjEa35q4I,31307
 geobox/model3d.py,sha256=qRYCx-q9LpGhdu5oz3av0uUoiDimuk4BvXXwMW5bo9Q,12061
@@ -30,8 +30,8 @@ geobox/vectorlayer.py,sha256=xnYsJei-bpKgM_EJlRbZ-bAIHdmvfU-VZ2t-NEEJCfc,49420
 geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
 geobox/view.py,sha256=fRYlzNu4eGl6Zx9gPom47BkVE8DfWLj0bNlW2-u4TOU,37390
 geobox/workflow.py,sha256=6hKnSw4G0_ZlgmUb0g3fxT-UVsFbiYpF2FbEO5fpQv0,11606
-geobox-1.1.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-1.1.0.dist-info/METADATA,sha256=7tl1V2oQpCqPITA_wXvZ2_zr8vCtu5URSxQ81u5Fe-E,2556
-geobox-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-1.1.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-1.1.0.dist-info/RECORD,,
+geobox-1.2.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-1.2.0.dist-info/METADATA,sha256=F2b-L6jZYKlOsWSZnwf-zZu5lFTLbI1XeNKwVUse41M,2556
+geobox-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-1.2.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-1.2.0.dist-info/RECORD,,