terrakio-core 0.1.9__tar.gz

terrakio_core-0.1.9/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: terrakio-core
+Version: 0.1.9
+Summary: Core components for Terrakio API clients
+Home-page: https://github.com/HaizeaAnalytics/terrakio-python-api
+Author: Yupeng Chao
+Author-email: Yupeng Chao <yupeng@haizea.com.au>
+Project-URL: Homepage, https://github.com/HaizeaAnalytics/terrakio-python-api
+Project-URL: Bug Tracker, https://github.com/HaizeaAnalytics/terrakio-python-api/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.25.0
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: xarray>=2023.1.0
+Requires-Dist: shapely>=2.0.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# Terrakio Core
+
+Core components for Terrakio API clients. This package provides the foundational classes and utilities used by both the regular and admin API clients.
+
+This package is typically not used directly but is a dependency for:
+- `terrakio-api`: Regular user client
+- `terrakio-admin-api`: Administrative client
+
+For documentation and usage examples, see the [main repository](https://github.com/HaizeaAnalytics/terrakio-python-api). 

terrakio_core-0.1.9/README.md

@@ -0,0 +1,9 @@
+# Terrakio Core
+
+Core components for Terrakio API clients. This package provides the foundational classes and utilities used by both the regular and admin API clients.
+
+This package is typically not used directly but is a dependency for:
+- `terrakio-api`: Regular user client
+- `terrakio-admin-api`: Administrative client
+
+For documentation and usage examples, see the [main repository](https://github.com/HaizeaAnalytics/terrakio-python-api). 

terrakio_core-0.1.9/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "terrakio-core"
+version = "0.1.9"
+authors = [
+    {name = "Yupeng Chao", email = "yupeng@haizea.com.au"},
+]
+description = "Core components for Terrakio API clients"
+readme = "README.md"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Development Status :: 4 - Beta",
+]
+dependencies = [
+    "requests>=2.25.0",
+    "pyyaml>=5.1",
+    "xarray>=2023.1.0",
+    "shapely>=2.0.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/HaizeaAnalytics/terrakio-python-api"
+"Bug Tracker" = "https://github.com/HaizeaAnalytics/terrakio-python-api/issues" 

terrakio_core-0.1.9/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

terrakio_core-0.1.9/setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages  # Make sure to import find_packages
+
+setup(
+    name="terrakio_core",
+    version="0.1.9",
+    author="Yupeng Chao",
+    author_email="yupeng@haizea.com.au",
+    description="Core components for Terrakio API clients",
+    url="https://github.com/HaizeaAnalytics/terrakio-python-api",
+    packages = find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 4 - Beta",
+    ],
+    python_requires=">=3.7",
+    install_requires=[
+        "requests>=2.25.0",
+        "pyyaml>=5.1",
+        "xarray>=2023.1.0",
+        "shapely>=2.0.0",
+    ],
+    metadata_version='2.2'
+) 

terrakio_core-0.1.9/terrakio_core/auth.py

@@ -0,0 +1,237 @@
+import requests
+from typing import Optional, Dict, Any
+from .exceptions import APIError, ConfigurationError
+
+class AuthClient:
+    def __init__(self, base_url: str = "https://dev-au.terrak.io", 
+                 verify: bool = True, timeout: int = 60):
+        """
+        Initialize the Authentication Client for Terrakio API.
+        
+        Args:
+            base_url: Authentication API base URL
+            verify: Verify SSL certificates
+            timeout: Request timeout in seconds
+        """
+        self.base_url = base_url.rstrip('/')
+        self.verify = verify
+        self.timeout = timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            'Content-Type': 'application/json'
+        })
+        self.token = None
+        self.api_key = None
+    
+    def signup(self, email: str, password: str) -> Dict[str, Any]:
+        """
+        Register a new user account.
+        
+        Args:
+            email: User email address
+            password: User password
+        
+        Returns:
+            API response data
+        
+        Raises:
+            APIError: If signup fails
+        """
+        endpoint = f"{self.base_url}/users/signup"
+        
+        payload = {
+            "email": email,
+            "password": password
+        }
+        
+        try:
+            response = self.session.post(
+                endpoint, 
+                json=payload,
+                verify=self.verify,
+                timeout=self.timeout
+            )
+            
+            if not response.ok:
+                error_msg = f"Signup failed: {response.status_code} {response.reason}"
+                try:
+                    error_data = response.json()
+                    if "detail" in error_data:
+                        error_msg += f" - {error_data['detail']}"
+                except:
+                    pass
+                raise APIError(error_msg)
+            
+            return response.json()
+        except requests.RequestException as e:
+            raise APIError(f"Signup request failed: {str(e)}")
+    
+    def login(self, email: str, password: str) -> str:
+        """
+        Log in and obtain authentication token.
+        
+        Args:
+            email: User email address
+            password: User password
+        
+        Returns:
+            Authentication token
+        
+        Raises:
+            APIError: If login fails
+        """
+        endpoint = f"{self.base_url}/users/login"
+        
+        payload = {
+            "email": email,
+            "password": password
+        }
+        
+        try:
+            response = self.session.post(
+                endpoint, 
+                json=payload,
+                verify=self.verify,
+                timeout=self.timeout
+            )
+            
+            if not response.ok:
+                error_msg = f"Login failed: {response.status_code} {response.reason}"
+                try:
+                    error_data = response.json()
+                    if "detail" in error_data:
+                        error_msg += f" - {error_data['detail']}"
+                except:
+                    pass
+                raise APIError(error_msg)
+            
+            result = response.json()
+            self.token = result.get("token")
+            
+            # Update session with authorization header
+            if self.token:
+                self.session.headers.update({
+                    "Authorization": self.token
+                })
+            
+            return self.token
+        except requests.RequestException as e:
+            raise APIError(f"Login request failed: {str(e)}")
+    
+    def refresh_api_key(self) -> str:
+        """
+        Generate or refresh API key.
+        
+        Returns:
+            API key
+        
+        Raises:
+            ConfigurationError: If not authenticated
+            APIError: If refresh fails
+        """
+        if not self.token:
+            raise ConfigurationError("Not authenticated. Call login() first.")
+        
+        endpoint = f"{self.base_url}/users/refresh_key"
+        
+        try:
+            # Use session with updated headers from login
+            response = self.session.post(
+                endpoint,
+                verify=self.verify,
+                timeout=self.timeout
+            )
+            
+            if not response.ok:
+                error_msg = f"API key generation failed: {response.status_code} {response.reason}"
+                try:
+                    error_data = response.json()
+                    if "detail" in error_data:
+                        error_msg += f" - {error_data['detail']}"
+                except:
+                    pass
+                raise APIError(error_msg)
+            
+            result = response.json()
+            self.api_key = result.get("apiKey")
+            return self.api_key
+        except requests.RequestException as e:
+            raise APIError(f"API key refresh request failed: {str(e)}")
+    
+    def view_api_key(self) -> str:
+        """
+        Retrieve current API key.
+        
+        Returns:
+            API key
+        
+        Raises:
+            ConfigurationError: If not authenticated
+            APIError: If retrieval fails
+        """
+        if not self.token:
+            raise ConfigurationError("Not authenticated. Call login() first.")
+        
+        endpoint = f"{self.base_url}/users/key"
+        
+        try:
+            # Use session with updated headers from login
+            response = self.session.get(
+                endpoint,
+                verify=self.verify,
+                timeout=self.timeout
+            )
+            
+            if not response.ok:
+                error_msg = f"Failed to retrieve API key: {response.status_code} {response.reason}"
+                try:
+                    error_data = response.json()
+                    if "detail" in error_data:
+                        error_msg += f" - {error_data['detail']}"
+                except:
+                    pass
+                raise APIError(error_msg)
+            
+            result = response.json()
+            self.api_key = result.get("apiKey")
+            return self.api_key
+        except requests.RequestException as e:
+            raise APIError(f"API key retrieval request failed: {str(e)}")
+    
+    def get_user_info(self) -> Dict[str, Any]:
+        """
+        Retrieve the current user's information.
+        
+        Returns:
+            User information data
+        
+        Raises:
+            ConfigurationError: If not authenticated
+            APIError: If retrieval fails
+        """
+        if not self.token:
+            raise ConfigurationError("Not authenticated. Call login() first.")
+        
+        endpoint = f"{self.base_url}/users/info"
+        
+        try:
+            # Use session with updated headers from login
+            response = self.session.get(
+                endpoint,
+                verify=self.verify,
+                timeout=self.timeout
+            )
+            
+            if not response.ok:
+                error_msg = f"Failed to retrieve user info: {response.status_code} {response.reason}"
+                try:
+                    error_data = response.json()
+                    if "detail" in error_data:
+                        error_msg += f" - {error_data['detail']}"
+                except:
+                    pass
+                raise APIError(error_msg)
+            
+            return response.json()
+        except requests.RequestException as e:
+            raise APIError(f"User info retrieval request failed: {str(e)}")