pygeobox 1.0.0__py3-none-any.whl

pygeobox/dashboard.py

@@ -0,0 +1,316 @@
+from typing import List, Dict, Optional, TYPE_CHECKING, Union
+from urllib.parse import urljoin
+
+from .base import Base
+
+if TYPE_CHECKING:
+    from . import GeoboxClient
+    from .user import User
+
+class Dashboard(Base):
+
+    BASE_ENDPOINT = 'dashboards/'
+
+    def __init__(self, 
+                 api: 'GeoboxClient', 
+                 uuid: str,
+                 data: Optional[Dict] = {}):
+        """
+        Initialize a Dashboard instance.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The unique identifier for the Dashboard.
+            data (Dict, optional): The data of the Dashboard.
+        """
+        super().__init__(api, uuid=uuid, data=data)
+
+
+    @classmethod
+    def get_dashboards(cls, api: 'GeoboxClient', **kwargs) -> Union[List['Dashboard'], int]:
+        """
+        Get list of Dashboards
+
+        Args:
+            api (GeoboxClient): The GeoboxClient 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 Dashboards. default is False.
+
+        Returns:
+            List[Dashboard] | int: A list of Dashboard instances or the total number of Dashboards.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboards = Dashboard.get_dashboards(client)
+            or
+            >>> dashboards = client.get_dashboards()
+        """
+        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 super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Dashboard(api, item['uuid'], item))
+    
+
+    @classmethod
+    def create_dashboard(cls, 
+                     api: 'GeoboxClient', 
+                     name: str, 
+                     display_name: str = None, 
+                     description: str = None, 
+                     settings: Dict = {}, 
+                     thumbnail: str = None, 
+                     user_id: int = None) -> 'Dashboard':
+        """
+        Create a new Dashboard.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): The name of the Dashboard.
+            display_name (str, optional): The display name of the Dashboard.
+            description (str, optional): The description of the Dashboard.
+            settings (Dict, optional): The settings of the sceDashboarde.
+            thumbnail (str, optional): The thumbnail of the Dashboard.
+            user_id (int, optional): Specific user. privileges required.
+
+        Returns:
+            Dashboard: The newly created Dashboard instance.
+
+        Raises:
+            ValidationError: If the Dashboard data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.create_dashboard(client, name="my_dashboard")
+            or
+            >>> dashboard = client.create_dashboard(name="my_dashboard")
+        """
+        data = {
+            "name": name,
+            "display_name": display_name,
+            "description": description,
+            "settings": settings,
+            "thumbnail": thumbnail,
+            "user_id": user_id,
+        }
+        return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Dashboard(api, item['uuid'], item))
+
+    
+    @classmethod
+    def get_dashboard(cls, api: 'GeoboxClient', uuid: str, user_id: int = None) -> 'Dashboard':
+        """
+        Get a Dashboard by its UUID.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            uuid (str): The UUID of the Dashboard to get.
+            user_id (int, optional): Specific user. privileges required.
+
+        Returns:
+            Dashboard: The dashboard object.
+
+        Raises:
+            NotFoundError: If the Dashboard with the specified UUID is not found.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            or
+            >>> dashboard = client.get_dashboard(uuid="12345678-1234-5678-1234-567812345678")
+        """
+        params = {
+            'f': 'json',
+            'user_id': user_id,
+        }
+        return super()._get_detail(api, cls.BASE_ENDPOINT, uuid, params, factory_func=lambda api, item: Dashboard(api, item['uuid'], item))
+
+
+    @classmethod
+    def get_dashboard_by_name(cls, api: 'GeoboxClient', name: str, user_id: int = None) -> Union['Dashboard', None]:
+        """
+        Get a dashboard by name
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): the name of the dashboard to get
+            user_id (int, optional): specific user. privileges required.
+
+        Returns:
+            Dashboard | None: returns the dashboard if a dashboard matches the given name, else None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard_by_name(client, name='test')
+            or
+            >>> dashboard = client.get_dashboard_by_name(name='test')
+        """
+        dashboards = cls.get_dashboards(api, q=f"name = '{name}'", user_id=user_id)
+        if dashboards and dashboards[0].name == name:
+            return dashboards[0]
+        else:
+            return None
+
+
+    def update(self, **kwargs) -> Dict:
+        """
+        Update the Dashboard
+
+        Keyword Args:
+            name (str): The name of the Dashboard.
+            display_name (str): The display name of the Dashboard.
+            description (str): The description of the Dashboard.
+            settings (Dict): The settings of the Dashboard.
+            thumbnail (str): The thumbnail of the Dashboard.
+
+        Returns:
+            Dict: The updated Dashboard data.
+
+        Raises:
+            ValidationError: If the Dashboard data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> dashboard.update(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 super()._update(self.endpoint, data)
+    
+
+    def delete(self) -> None:
+        """
+        Delete the dashboard.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> dashboard.delete()
+        """        
+        super().delete(self.endpoint)
+
+
+    @property
+    def thumbnail(self) -> str:
+        """
+        Get the thumbnail URL of the dashboard.
+
+        Returns:
+            str: The thumbnail of the dashboard.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> dashboard.thumbnail
+            'https://example.com/thumbnail.png'
+        """
+        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
+        return endpoint
+    
+
+    def share(self, users: List['User']) -> None:
+        """
+        Shares the Dashboard with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to share the Dashboard with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> dashboard.share(users=users)
+        """
+        super()._share(self.endpoint, users)
+    
+
+    def unshare(self, users: List['User']) -> None:
+        """
+        Unshares the Dashboard with specified users.
+
+        Args:
+            users (List[User]): The list of user objects to unshare the Dashboard with.
+
+        Returns:
+            None
+
+        Example:
+            >>> from geobox import GeoboxClient             
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> users = client.search_users(search='John')
+            >>> dashboard.unshare(users=users)
+        """
+        super()._unshare(self.endpoint, users)
+
+
+    def get_shared_users(self, search: str = None, skip: int = 0, limit: int = 10) -> List['User']:
+        """
+        Retrieves the list of users the dashboard 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 import GeoboxClient             
+            >>> from geobox.dashboard import Dashboard
+            >>> client = GeoboxClient()
+            >>> dashboard = Dashboard.get_dashboard(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> dashboard.get_shared_users(search='John', skip=0, limit=10)
+        """
+        params = {
+            'search': search,
+            'skip': skip,
+            'limit': limit
+        }
+        return super()._get_shared_users(self.endpoint, params)

pygeobox/enums.py

@@ -0,0 +1,355 @@
+from enum import Enum
+
+# File Enums
+class InputGeomType(Enum):
+    POINT = 'POINT'
+    LINE = 'LINE'
+    POLYGON = 'POLYGON'
+    MULTIPOINT = 'MULTIPOINT'
+    MULTILINE = 'MULTILINE'
+    MULTIPOLYGON = 'MULTIPOLYGON'
+    POINT_Z = 'POINTZ'
+    LINE_Z = 'LINEZ'
+    POLYGON_Z = 'POLYGONZ'
+    MULTIPOINT_Z = 'MULTIPOINTZ'
+    MULTILINE_Z = 'MULTILINEZ'
+    MULTIPOLYGON_Z = 'MULTIPOLYGONZ'
+    
+class PublishFileType(Enum):
+    VECTOR = 'vector'
+    RASTER = 'raster'
+    MODEL3D = 'model3d'
+
+class FileType(Enum):
+    # Spatial Data Formats
+    Shapefile = '.shp'
+    FileGDB = '.gdb'
+    CSV = '.csv'
+    KML = '.kml'
+    DXF = '.dxf'
+    GPX = '.gpx'
+    GPKG = '.gpkg'
+    GeoJSON = '.geojson'
+    GeoTIFF = '.tif'
+
+    # Image Formats
+    JPG = '.jpg'
+    JPEG = '.jpeg'
+    SVG = '.svg'
+    PNG = '.png'
+    BMP = '.bmp'
+    TIF = '.tif'
+    GIF = '.gif'
+
+    # Video Formats
+    MP4 = '.mp4'
+    AVI = '.avi'
+    OGG = '.ogg'
+    WEBM = '.webm'
+    MPEG = '.mpeg'
+    WMV = '.wmv'
+
+    # Document Formats
+    TXT = '.txt'
+    DOC = '.doc'
+    DOCX = '.docx'
+    XLS = '.xls'
+    XLSX = '.xlsx'
+    PPT = '.ppt'
+    PPTX = '.pptx'
+    PDF = '.pdf'
+
+    # Compressed Formats
+    ZIP = '.zip'
+    SEVEN_Z = '.7z'  # 7z
+    RAR = '.rar'
+    ISO = '.iso'
+    GZ = '.gz'
+    BZ2 = '.bz2'
+    TAR = '.tar'
+    CAB = '.cab'
+    IMG = '.img'
+
+
+# Field Enums
+class FieldType(Enum):
+    """
+    A class representing the data type of a field.
+    """
+    Integer = "Integer"
+    """
+    An integer field.
+    """
+    Float = "Float"
+    """
+    A float field.
+    """
+    String = "String"
+    """
+    A string field.
+    """
+    Long = "Long"
+    """
+    A Long field.
+    """
+    DATE = "Date"
+    """
+    A Date field.
+    """
+    TIME = "Time"
+    """
+    A Time Field.
+    """
+    DATETIME = "DateTime"
+    """
+    A DateTime Field.
+    """
+
+
+# Layer Enums
+class LayerType(Enum):
+    """
+    Enumeration of supported vector layer geometry types.
+    
+    This enum defines the different types of geometric shapes that can be stored in a vector layer.
+    Each type represents a specific geometric structure supported by the Geobox API.
+    """
+    Point = "Point"
+    """A single point in 2D space"""
+    
+    LineString = "LineString"
+    """A sequence of points forming a line"""
+    
+    Polygon = "Polygon"
+    """A closed shape defined by a sequence of points"""
+    
+    MultiPoint = "MultiPoint"
+    """A collection of points"""
+    
+    MultiLineString = "MultiLineString"
+    """A collection of lines"""
+    
+    MultiPolygon = "MultiPolygon"
+    """A collection of polygons"""
+
+    Polyline = "Polyline"
+    """A polyline geometry"""
+
+
+# Layer Enums
+class FeatureType(Enum):
+    """
+    Enumeration of supported feature geometry types.
+    
+    This enum defines the different types of geometric shapes that can be stored in a feature.
+    Each type represents a specific geometric structure supported by the Geobox API.
+    """
+    Point = "Point"
+    """A single point in 2D space"""
+    
+    LineString = "LineString"
+    """A sequence of points forming a line"""
+    
+    Polygon = "Polygon"
+    """A closed shape defined by a sequence of points"""
+    
+    MultiPoint = "MultiPoint"
+    """A collection of points"""
+    
+    MultiLineString = "MultiLineString"
+    """A collection of lines"""
+    
+    MultiPolygon = "MultiPolygon"
+    """A collection of polygons"""
+
+    Polyline = "Polyline"
+    """A polyline geometry"""
+
+
+# Task Enums
+class TaskStatus(Enum):
+    """
+    Enumeration of possible task statuses.
+    """
+    PENDING = "PENDING"
+    """
+    The task is pending.
+    """
+    PROGRESS = "PROGRESS"
+    """
+    The task is in progress.
+    """
+    SUCCESS = "SUCCESS"
+    """
+    The task is successful.
+    """
+    FAILURE = "FAILURE"
+    """
+    The task is failed.
+    """
+    ABORTED = "ABORTED"
+    """
+    The task is aborted.
+    """
+
+class QueryGeometryType(Enum):
+    """
+    Enumeration of possible query geometry types.
+    """
+    POINT = "Point"
+    """
+    A point geometry.
+    """
+    MULTIPOINT = "Multipoint"
+    """
+    A multipoint geometry.
+    """
+    POLYLINE = "Polyline"
+    """
+    A polyline geometry.
+    """
+    POLYGON = "Polygon"
+    """
+    A polygon geometry.
+    """
+
+class QueryParamType(Enum):
+    """
+    Enumeration of possible query parameter types.
+    """
+    LAYER = "Layer"
+    """
+    A layer parameter.
+    """
+    ATTRIBUTE = "Attribute"
+    """
+    A Attribute parameter.
+    """
+    FLOAT = "Float"
+    """
+    A Float parameter.
+    """
+    INTEGER = "Integer"
+    """
+    A Integer parameter.
+    """
+    TEXT = "Text"
+    """
+    A Text parameter.
+    """
+    BOOLEAN = "Boolean"
+    """
+    A Boolean parameter.
+    """
+
+
+class UserRole(Enum):
+    SYSTEM_ADMIN = "System Admin"
+
+    ACCOUNT_ADMIN = "Account Admin"
+
+    PUBLISHER = "Publisher"
+
+    EDITOR = "Editor"
+
+    VIEWR = "Viewer"
+
+
+class UserStatus(Enum):
+    NEW = "New"
+
+    PENDING = "Pending"
+
+    ACTIVE = "Active"
+
+    DISABLED = "Disabled"
+
+
+class AttachmentResourceType(Enum):
+    Map = "map"
+
+    Vector = "vector"
+
+    View = "view"
+
+
+class MaxLogPolicy(Enum):
+    OverwriteFirstLog = "OverwriteFirstLog"
+
+    IgnoreLogging = "IgnoreLogging"
+
+
+class InvalidDataPolicy(Enum):
+    ReportToAdmin = "ReportToAdmin"
+
+    LogOnly = "LogOnly"
+
+
+class LoginFailurePolicy(Enum):
+    BlockIPTemporarily = "BlockIPTemporarily"
+
+    DisableAccount = "DisableAccount"
+
+
+class MaxConcurrentSessionPolicy(Enum):
+    CloseLastSession = "CloseLastSession"
+
+    CloseMostInactiveSession = "CloseMostInactiveSession"
+
+    PreventNewSession = "PreventNewSession"
+
+
+class RoutingGeometryType(Enum):
+    geojson = "geojson"
+
+    polyline = "polyline"
+
+    polyline6= "polyline6"
+
+
+class RoutingOverviewLevel(Enum):
+    Full = 'full'
+
+    Simplified = 'simplified'
+
+
+class QueryResultType(Enum):
+    metadata = "metadata"
+
+    data = "data"
+
+    both = "both"
+
+
+class TilesetLayerType(Enum):
+    Vector = "vector"
+
+    View = "view"
+
+
+class FileOutputFormat(Enum):
+    Shapefile = "Shapefile"
+
+    GPKG = "GPKG"
+
+    GeoJSON = "GeoJSON"
+
+    CSV = "CSV"
+
+    KML = "KML"
+
+    DXF = "DXF"
+
+
+class UsageScale(Enum):
+    Hour = 'hour'
+
+    Day = 'day'
+
+    Month = 'month'
+
+
+class UsageParam(Enum):
+    Traffict = 'traffic'
+
+    Calls = 'calls'