geobox 1.1.0__tar.gz → 1.2.0__tar.gz

{geobox-1.1.0 → geobox-1.2.0}/PKG-INFO

@@ -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 → geobox-1.2.0}/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-1.1.0 → geobox-1.2.0}/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-1.1.0 → geobox-1.2.0}/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 → geobox-1.2.0}/geobox.egg-info/PKG-INFO

@@ -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 → geobox-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "geobox"
-version = "1.1.0"
+version = "1.2.0"
 description = "SDK for Geobox's APIs"
 authors = [
   {name = "Hamid Heydari", email = "heydari.h62@gmail.com"}

{geobox-1.1.0 → geobox-1.2.0}/tests/test_api.py

@@ -737,7 +737,7 @@ def test_get_file(mock_file_data):
         assert file.data == mock_file_data
 
 
-def test_get_file_by_name(mock_file_data):
+def test_get_files_by_name(mock_file_data):
     with patch('geobox.api.GeoboxClient.get_access_token') as mock_get_token, \
          patch('geobox.api.GeoboxClient.get') as mock_get:
         
@@ -745,10 +745,10 @@ def test_get_file_by_name(mock_file_data):
         mock_get.return_value = [mock_file_data]
         
         client = GeoboxClient(username='testuser', password='testpassword')
-        file = client.get_file_by_name(name=mock_file_data['name'])
+        files = client.get_files_by_name(name=mock_file_data['name'])
         
-        assert isinstance(file, File)
-        assert file.data == mock_file_data
+        assert isinstance(files[0], File)
+        assert files[0].data == mock_file_data
 
 
 def test_upload_file():

{geobox-1.1.0 → geobox-1.2.0}/tests/test_file.py

@@ -24,7 +24,7 @@ def test_properties(api, mock_file_data):
     """Test File properties."""
     file = File(api, uuid=mock_file_data['uuid'], data=mock_file_data)
     assert file.name == 'world_boundaries.shp'
-    assert file.file_type == 'Shapefile'
+    assert file.file_type.value == 'Shapefile'
     assert file.size == 7588516
     assert file.feature_count == 394
     assert file.layer_count == 1
@@ -77,7 +77,7 @@ def test_upload_file_invalid_type(api):
     # Use the actual extension string
     invalid_extension = os.path.splitext(temp_file_path)[1]
 
-    with pytest.raises(ValueError, match=f".invalid' is not a valid FileType"):
+    with pytest.raises(ValueError, match=f".invalid' is not a valid FileFormat"):
         File.upload_file(api, temp_file_path)
 
     # Clean up
@@ -108,7 +108,7 @@ def test_get_files(api):
         api.get.assert_called_once_with(f"{File.BASE_ENDPOINT}?f=json&search=test&search_fields=name&return_count=False&skip=0&limit=2&shared=False")
 
 
-def test_get_file_by_uuid(api, mock_file_data):
+def test_get_file(api, mock_file_data):
     """Test getting file by UUID."""
     with patch.object(api, 'get', return_value=mock_file_data):
         file = File.get_file(api, uuid=mock_file_data['uuid'])
@@ -118,18 +118,15 @@ def test_get_file_by_uuid(api, mock_file_data):
         api.get.assert_called_once_with(f"{file.endpoint}info/?f=json")
 
 
-def test_get_file_by_name(api, mock_file_data):
+def test_get_files_by_name(api, mock_file_data):
     """Test getting file by name."""
     mock_response = [mock_file_data]
     with patch.object(api, 'get', return_value=mock_response):
-        file = File.get_file_by_name(api, name=mock_file_data['name'])
-        assert isinstance(file, File)
-        assert file.uuid == mock_file_data['uuid']
-        assert file.name == mock_file_data['name']
-        api.get.assert_called_once_with(f"{file.BASE_ENDPOINT}?f=json&q=name+%3D+%27world_boundaries.shp%27&return_count=False&skip=0&limit=10&shared=False")
-        # not found
-        file = File.get_file_by_name(api, name='not_found')
-        assert file == None
+        files = File.get_files_by_name(api, name=mock_file_data['name'])
+        assert isinstance(files[0], File)
+        assert files[0].uuid == mock_file_data['uuid']
+        assert files[0].name == mock_file_data['name']
+        api.get.assert_called_once_with(f"{files[0].BASE_ENDPOINT}?f=json&q=name+%3D+%27world_boundaries.shp%27&return_count=False&skip=0&limit=10&shared=False")
 
 
 def test_download(api, mock_file_data):
@@ -268,24 +265,21 @@ def test_delete(api, mock_file_data):
         api.delete.assert_called_once_with(f'files/{mock_file_data["uuid"]}/')
 
 
-@pytest.mark.parametrize("publish_type,geom_type", [
-    (publish_type, geom_type)
-    for publish_type in PublishFileType
-    for geom_type in InputGeomType
+@pytest.mark.parametrize("file_type", [
+    (type)
+    for type in FileType
 ])
-def test_publish(api, mock_file_data, publish_type, mock_success_task_data, geom_type):
+def test_publish(api, mock_file_data, mock_success_task_data, file_type):
     """Test file publishing with all combinations of publish types and geometry types."""
     mock_response = {
         'task_id': mock_success_task_data['id']
     }
-    
+    mock_file_data['file_type'] = file_type.value
     with patch.object(api, 'post', return_value=mock_response) as mock_post:
         with patch.object(api, 'get', return_value=mock_success_task_data) as mock_post:
             file = File(api, uuid=mock_file_data['uuid'], data=mock_file_data)
             result = file.publish(
-                publish_as=publish_type,
-                name='test_layer',
-                input_geom_type=geom_type
+                name='test_layer'
             )
             
             # Verify the response