geobox 1.4.2__py3-none-any.whl → 2.0.1__py3-none-any.whl

geobox/aio/workflow.py

@@ -0,0 +1,341 @@
+from typing import List, Dict, Optional, TYPE_CHECKING, Union
+
+from .base import AsyncBase
+
+if TYPE_CHECKING:
+    from . import AsyncGeoboxClient
+    from .user import User
+    from ..api import GeoboxClient as SyncGeoboxClient
+    from ..workflow import Workflow as SyncWorkflow
+
+
+class Workflow(AsyncBase):
+
+    BASE_ENDPOINT = 'workflows/'
+
+    def __init__(self, 
+                 api: 'AsyncGeoboxClient', 
+                 uuid: str,
+                 data: Optional[Dict] = {}):
+        """
+        Initialize an async workflow instance. 
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The unique identifier for the workflow.
+            data (Dict): The data of the workflow.
+        """
+        super().__init__(api, uuid=uuid, data=data)
+
+
+    @classmethod
+    async def get_workflows(cls, api: 'AsyncGeoboxClient', **kwargs) -> Union[List['Workflow'], int]:
+        """
+        [async] Get list of workflows with optional filtering
+
+        Args:
+            api (AsyncGeoboxClient): The AsyncGeoboxClient 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 workflows. default is False.
+
+        Returns:
+            List[Workflow] | int: A list of workflow instances or the total number of workflows.
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflows = await Workflow.get_workflows(client, q="name LIKE '%My workflow%'")
+            or
+            >>>     workflows = await client.get_workflows(q="name LIKE '%My workflow%'")
+        """
+        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 await super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Workflow(api, item['uuid'], item))
+    
+
+    @classmethod
+    async def create_workflow(cls, 
+                     api: 'AsyncGeoboxClient', 
+                     name: str, 
+                     display_name: str = None, 
+                     description: str = None, 
+                     settings: Dict = {}, 
+                     thumbnail: str = None, 
+                     user_id: int = None) -> 'Workflow':
+        """
+        [async] Create a new workflow.
+
+        Args:
+            api (AsyncGeoboxClient): The AsyncGeoboxClient instance for making requests.
+            name (str): The name of the Workflow.
+            display_name (str): The display name of the workflow.
+            description (str): The description of the workflow.
+            settings (Dict): The settings of the workflow.
+            thumbnail (str): The thumbnail of the workflow.
+            user_id (int): Specific user. privileges required.
+
+        Returns:
+            Workflow: The newly created workflow instance.
+
+        Raises:
+            ValidationError: If the workflow data is invalid.
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.create_workflow(client, name="my_workflow")
+            or
+            >>>     workflow = await client.create_workflow(name="my_workflow")
+        """
+        data = {
+            "name": name,
+            "display_name": display_name,
+            "description": description,
+            "settings": settings,
+            "thumbnail": thumbnail,
+            "user_id": user_id,
+        }
+        return await super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Workflow(api, item['uuid'], item))
+
+    
+    @classmethod
+    async def get_workflow(cls, api: 'AsyncGeoboxClient', uuid: str, user_id: int = None) -> 'Workflow':
+        """
+        [async] Get a workflow by its UUID.
+
+        Args:
+            api (AsyncGeoboxClient): The AsyncGeoboxClient instance for making requests.
+            uuid (str): The UUID of the workflow to get.
+            user_id (int): Specific user. privileges required.
+
+        Returns:
+            Workflow: The workflow object.
+
+        Raises:
+            NotFoundError: If the workflow with the specified UUID is not found.
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>>     workflow = await client.get_workflow(uuid="12345678-1234-5678-1234-567812345678")
+        """
+        params = {
+            'f': 'json',
+            'user_id': user_id,
+        }
+        return await super()._get_detail(api, cls.BASE_ENDPOINT, uuid, params, factory_func=lambda api, item: Workflow(api, item['uuid'], item))
+
+
+    @classmethod
+    async def get_workflow_by_name(cls, api: 'AsyncGeoboxClient', name: str, user_id: int = None) -> Union['Workflow', None]:
+        """
+        [async] Get a workflow by name
+
+        Args:
+            api (AsyncGeoboxClient): The AsyncGeoboxClient instance for making requests.
+            name (str): the name of the workflow to get
+            user_id (int, optional): specific user. privileges required.
+
+        Returns:
+            Workflow | None: returns the workflow if a workflow matches the given name, else None
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow_by_name(client, name='test')
+            or
+            >>>     workflow = await client.get_workflow_by_name(name='test')
+        """
+        workflows = await cls.get_workflows(api, q=f"name = '{name}'", user_id=user_id)
+        if workflows and workflows[0].name == name:
+            return workflows[0]
+        else:
+            return None
+
+
+    async def update(self, **kwargs) -> Dict:
+        """
+        [async] Update the workflow.
+
+        Keyword Args:
+            name (str): The name of the workflow.
+            display_name (str): The display name of the workflow.
+            description (str): The description of the workflow.
+            settings (Dict): The settings of the workflow.
+            thumbnail (str): The thumbnail of the workflow.
+
+        Returns:
+            Dict: The updated workflow data.
+
+        Raises:
+            ValidationError: If the workflow data is invalid.
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     await workflow.update_workflow(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 await super()._update(self.endpoint, data)
+    
+
+    async def delete(self) -> None:
+        """
+        [async] Delete the Workflow.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     await workflow.delete()
+        """
+        await super().delete(self.endpoint)
+
+
+    @property
+    def thumbnail(self) -> str:
+        """
+        Get the thumbnail URL of the Workflow.
+
+        Returns:
+            str: The thumbnail of the Workflow.
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     workflow.thumbnail
+            'https://example.com/thumbnail.png'
+        """
+        return super().thumbnail()
+    
+
+    async def share(self, users: List['User']) -> None:
+        """
+        [async] Shares the workflow with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to share the workflow with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     users = await client.search_users(search='John')
+            >>>     await workflow.share(users=users)
+        """
+        await super()._share(self.endpoint, users)
+    
+
+    async def unshare(self, users: List['User']) -> None:
+        """
+        [async] Unshares the workflow with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to unshare the workflow with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     users = await client.search_users(search='John')
+            >>>     await workflow.unshare(users=users)
+        """
+        await super()._unshare(self.endpoint, users)
+
+
+    async def get_shared_users(self, search: str = None, skip: int = 0, limit: int = 10) -> List['User']:
+        """
+        [async] Retrieves the list of users the workflow 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.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> async with AsyncGeoboxClient() as client:
+            >>>     workflow = await Workflow.get_workflow(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     await workflow.get_shared_users(search='John', skip=0, limit=10)
+        """
+        params = {
+            'search': search,
+            'skip': skip,
+            'limit': limit
+        }
+        return await super()._get_shared_users(self.endpoint, params)
+
+
+    def to_sync(self, sync_client: 'SyncGeoboxClient') -> 'SyncWorkflow':
+        """
+        Switch to sync version of the workflow instance to have access to the sync methods
+
+        Args:
+            sync_client (SyncGeoboxClient): The sync version of the GeoboxClient instance for making requests.
+
+        Returns:
+            geobox.workflow.Workflow: the sync instance of the workflow.
+
+        Example:
+            >>> from geobox import Geoboxclient
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.aio.workflow import Workflow
+            >>> client = GeoboxClient()
+            >>> async with AsyncGeoboxClient() as async_client:
+            >>>     workflow = await Workflow.get_workflow(async_client, uuid="12345678-1234-5678-1234-567812345678")
+            >>>     sync_workflow = workflow.to_sync(client)
+        """
+        from ..workflow import Workflow as SyncWorkflow
+
+        return SyncWorkflow(api=sync_client, uuid=self.uuid, data=self.data)

geobox/api.py

@@ -712,14 +712,14 @@ class GeoboxClient:
             >>> from geobox import GeoboxClient
             >>> client = GeoboxClient()
             >>> views = client.get_views(layer_id=1,
-                                            include_settings=True,
-                                            search="test",
-                                            search_fields="name",
-                                            order_by="name A",
-                                            return_count=False,
-                                            skip=0,
-                                            limit=10,
-                                            shared=True)
+            ...                             include_settings=True,
+            ...                             search="test",
+            ...                             search_fields="name",
+            ...                             order_by="name A",
+            ...                             return_count=False,
+            ...                             skip=0,
+            ...                             limit=10,
+            ...                             shared=True)
         """
         return VectorLayerView.get_views(self, **kwargs)
 
@@ -744,7 +744,7 @@ class GeoboxClient:
         return VectorLayerView.get_views_by_ids(self, ids, user_id, include_settings)
     
 
-    def get_view(self, uuid: str) -> 'VectorLayerView':
+    def get_view(self, uuid: str, user_id: int = None) -> 'VectorLayerView':
         """
         Get a specific vector layer view by its UUID.
 
@@ -760,7 +760,7 @@ class GeoboxClient:
             >>> client = GeoboxClient()
             >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
         """
-        return VectorLayerView.get_view(self, uuid)
+        return VectorLayerView.get_view(self, uuid, user_id)
 
 
     def get_view_by_name(self, name: str, user_id: int = None) -> Union['VectorLayerView', None]:
@@ -801,7 +801,6 @@ class GeoboxClient:
 
         Example:
             >>> from geobox import GeoboxClient
-            >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
             >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
             >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
@@ -1304,13 +1303,14 @@ class GeoboxClient:
         return Query.get_queries(self, **kwargs)
     
 
-    def create_query(self, name: str, display_name: str = None, sql: str = None, params: List = None) -> 'Query':
+    def create_query(self, name: str, display_name: str = None, description: str = None, sql: str = None, params: List = None) -> 'Query':
         """
         Creates a new query.
 
         Args:
             name (str): The name of the query.
             display_name (str, optional): The display name of the query.
+            description (str, optional): The description of the query.
             sql (str, optional): The SQL statement for the query.
             params (list, optional): The parameters for the SQL statement.
 
@@ -1322,7 +1322,7 @@ class GeoboxClient:
             >>> client = GeoboxClient()
             >>> query = client.create_query(name='query_name', display_name='Query Name', sql='SELECT * FROM some_layer')
         """
-        return Query.create_query(self, name, display_name, sql, params)
+        return Query.create_query(self, name, display_name, description, sql, params)
     
 
     def get_query(self, uuid: str, user_id: int = None) -> 'Query':
@@ -2019,7 +2019,7 @@ class GeoboxClient:
         Example:
             >>> from geobox import GeoboxClient
             >>> client = GeoboxClient()
-            >>> plans = client.get_plan(q="name LIKE '%My plan%'")
+            >>> plans = client.get_plans(q="name LIKE '%My plan%'")
         """
         return Plan.get_plans(self, **kwargs)
     
@@ -2317,7 +2317,6 @@ class GeoboxClient:
 
         Example:
             >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
             >>> client = GeoboxClient()
             >>> map = client.get_maps()[0]
             >>> attachments = client.get_attachments(resource=map)

geobox/apikey.py

@@ -6,6 +6,9 @@ from .utils import clean_data
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .aio import AsyncGeoboxClient
+    from .aio.apikey import ApiKey as AsyncApikey
+
 
 class ApiKey(Base):
 
@@ -233,4 +236,28 @@ class ApiKey(Base):
         """
         endpoint = f"{self.endpoint}/grant"
         self.api.post(endpoint)
-        self.data['revoked'] = False
+        self.data['revoked'] = False
+
+
+    def to_async(self, async_client: 'AsyncGeoboxClient') -> 'AsyncApikey':
+        """
+        Switch to async version of the apikey instance to have access to the async methods
+
+        Args:
+            async_client (AsyncGeoboxClient): The async version of the GeoboxClient instance for making requests.
+
+        Returns:
+            geobox.aio.apikey.Apikey: the async instance of the apikey.
+
+        Example:
+            >>> from geobox import Geoboxclient
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.apikey import ApiKey
+            >>> client = GeoboxClient()
+            >>> apikey = ApiKey.get_apikey(client, key_id=1)
+            >>> async with AsyncGeoboxClient() as async_client:
+            >>>     async_apikey = apikey.to_async(async_client)
+        """
+        from .aio.apikey import ApiKey as AsyncApiKey
+
+        return AsyncApiKey(api=async_client, key_id=self.key_id, data=self.data)

geobox/attachment.py

@@ -11,6 +11,9 @@ from .file import File
 if TYPE_CHECKING:
     from . import GeoboxClient 
     from .feature import Feature
+    from .aio import AsyncGeoboxClient
+    from .aio.attachment import Attachment as AsyncAtachment
+
 
 class Attachment(Base):
 
@@ -309,4 +312,27 @@ class Attachment(Base):
             'https://example.com/thumbnail.png'
         """
         return super().thumbnail(format='')
-    
+    
+
+    def to_async(self, async_client: 'AsyncGeoboxClient') -> 'AsyncAtachment':
+        """
+        Switch to async version of the attachment instance to have access to the async methods
+
+        Args:
+            async_client (AsyncGeoboxClient): The async version of the GeoboxClient instance for making requests.
+
+        Returns:
+            geobox.aio.attachment.Atachment: the async instance of the attachment.
+
+        Example:
+            >>> from geobox import Geoboxclient
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> attachment = Attachment.get_attachment(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> async with AsyncGeoboxClient() as async_client:
+            >>>     async_attachment = attachment.to_async(async_client)
+        """
+        from .aio.attachment import Attachment as AsyncAttachment
+
+        return AsyncAttachment(api=async_client, attachment_id=self.attachment_id, data=self.data)

geobox/base.py

@@ -18,7 +18,7 @@ class Base:
         Initialize the Base class.
 
         Args:
-            api (GeoboxClient): The API client
+            api (GeoboxClient): The GeoboxClient client
             uuid (str, optional): The UUID of the resource
             data (dict, optional): The data of the resource
         """
@@ -129,7 +129,7 @@ class Base:
         Internal method to get a list of resources by their IDs.
 
         Args:
-            api (GeoboxClient): The API client
+            api (GeoboxClient): The GeoboxClient client
             endpoint (str): The endpoint of the resource
             params (dict): Additional parameters for filtering and pagination
             factory_func (Callable): A function to create the resource object
@@ -150,7 +150,7 @@ class Base:
         Internal method to get a single resource by UUID.
         
         Args:
-            api (GeoboxClient): The API client
+            api (GeoboxClient): The GeoboxClient client
             uuid (str): The UUID of the resource
             params (dict): Additional parameters for filtering and pagination
             factory_func (Callable): A function to create the resource object
@@ -170,7 +170,7 @@ class Base:
         Internal method to create a resource.
 
         Args:
-            api (GeoboxClient): The API client
+            api (GeoboxClient): The GeoboxClient client
             data (dict): The data to create the resource with
             factory_func (Callable): A function to create the resource object
 

geobox/basemap.py

@@ -7,6 +7,9 @@ from .utils import clean_data
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .aio import AsyncGeoboxClient
+    from .aio.basemap import Basemap as AsyncBasemap
+    
 
 class Basemap(Base):
 
@@ -163,4 +166,30 @@ class Basemap(Base):
         })
         query_string = urlencode(param)
         endpoint = urljoin(cls.BASE_ENDPOINT, f"?{query_string}")
-        api.get(endpoint)
+        api.get(endpoint)
+
+
+    def to_async(self, async_client: 'AsyncGeoboxClient') -> 'AsyncBasemap':
+        """
+        Switch to async version of the basemap instance to have access to the async methods
+
+        Args:
+            async_client (AsyncGeoboxClient): The async version of the GeoboxClient instance for making requests.
+
+        Returns:
+            geobox.aio.basemap.Basemap: the async instance of the basemap.
+
+        Example:
+            >>> from geobox import Geoboxclient
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.basemap import Basemap
+            >>> client = GeoboxClient()
+            >>> basemap = Basemap.get_basemap(client, name='test')
+            or
+            >>> basemap = client.get_basemap(name='test')
+            >>> async with AsyncGeoboxClient() as async_client:
+            >>>     async_basemap = basemap.to_async(async_client)
+        """
+        from .aio.basemap import Basemap as AsyncBasemap
+
+        return AsyncBasemap(api=async_client, data=self.data)

geobox/dashboard.py

@@ -6,6 +6,9 @@ from .base import Base
 if TYPE_CHECKING:
     from . import GeoboxClient
     from .user import User
+    from .aio import AsyncGeoboxClient
+    from .aio.dashboard import Dashboard as AsyncDashboard
+
 
 class Dashboard(Base):
 
@@ -313,3 +316,27 @@ class Dashboard(Base):
             'limit': limit
         }
         return super()._get_shared_users(self.endpoint, params)
+
+
+    def to_async(self, async_client: 'AsyncGeoboxClient') -> 'AsyncDashboard':
+        """
+        Switch to async version of the dashboard instance to have access to the async methods
+
+        Args:
+            async_client (AsyncGeoboxClient): The async version of the GeoboxClient instance for making requests.
+
+        Returns:
+            geobox.aio.dashboard.Dashboard: the async instance of the dashboard.
+
+        Example:
+            >>> from geobox import Geoboxclient
+            >>> from geobox.aio import AsyncGeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> async with AsyncGeoboxClient() as async_client:
+            >>>     async_dashboard = dashboard.to_async(async_client)
+        """
+        from .aio.dashboard import Dashboard as AsyncDashboard
+
+        return AsyncDashboard(api=async_client, uuid=self.uuid, data=self.data)