orb-cloud-client 1.2.1__tar.gz → 1.3.0__tar.gz

{orb_cloud_client-1.2.1/orb_cloud_client.egg-info → orb_cloud_client-1.3.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: orb-cloud-client
-Version: 1.2.1
+Version: 1.3.0
 Summary: Python client library for Orb Cloud API
 Author-email: Orb Networks <support@orb.net>
-License: MIT
+License-Expression: MIT
 Project-URL: Documentation, https://api.orb.net/docs
 Project-URL: Homepage, https://github.com/orbforge/orb-cloud
 Project-URL: Repository, https://github.com/orbforge/orb-cloud
@@ -21,6 +21,7 @@ License-File: LICENSE
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: httpx>=0.24.0
 Requires-Dist: pydantic>=2.0.0
+Requires-Dist: twine>=6.1.0
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0}/orb_cloud_client/client.py

@@ -5,11 +5,7 @@ Simple HTTP client for Orb Cloud API.
 import httpx
 from typing import Dict, Any, Optional, List
 
-try:
-    from .models import Device, TempDatasetsRequest, Organization
-except ImportError:
-    # Handle direct execution
-    from models import Device, TempDatasetsRequest, Organization
+from models.generic import Device, TempDatasetsRequest, Organization
 
 class OrbCloudClientBase(object):
     def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
@@ -28,6 +24,11 @@ class OrbCloudClientBase(object):
         response.raise_for_status()
         return response.json()
 
+    def _trigger_speedtest(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for triggering a speedtest."""
+        response.raise_for_status()
+        return response.json()
+
     def _get_organizations(self, response: httpx.Response) -> List[Organization]:
         """Get list of organizations accessible with the provided token."""
         response.raise_for_status()
@@ -65,6 +66,12 @@ class OrbCloudClient(OrbCloudClientBase):
         response = self.client.get("/api/v2/organizations")
         return self._get_organizations(response)
 
+    def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a content or top speedtest"""
+        response = self.client.post(f"/api/v2/device/{device_id}/trigger-speedtest/{test_type}")
+        return self._trigger_speedtest(response)
+
+
     def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
         """Make a raw HTTP request for any other endpoints."""
         return self.client.request(method, endpoint, **kwargs)
@@ -102,6 +109,11 @@ class OrbCloudClientAsync(OrbCloudClientBase):
         response = await self.client.get("/api/v2/organizations")
         return self._get_organizations(response)
 
+    async def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a content or top speedtest"""
+        response = await self.client.post("f/api/v2/device/{orbID}/trigger-speedtest/{testType}")
+        return self._trigger_speedtest(response)
+
     async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
         """Make a raw async HTTP request for any other endpoints."""
-        return await self.client.request(method, endpoint, **kwargs)
+        return await self.client.request(method, endpoint, **kwargs)

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0}/orb_cloud_client/example.py

@@ -17,26 +17,26 @@ from typing import Optional, List
 sys.path.insert(0, os.path.dirname(__file__))
 
 from client import OrbCloudClient
-from models import TempDatasetsRequest, Datasets, DataPush, Device
+from models.generic import TempDatasetsRequest, Datasets, DataPush, Device
 
 
 def get_and_display_devices(client: OrbCloudClient, organization_id: str) -> List[Device]:
     """Get and display all devices for the organization."""
     print(f"Getting devices for organization: {organization_id}")
-    
+
     try:
         devices = client.get_organization_devices(organization_id)
         print(f"Found {len(devices)} devices:\n")
-        
+
         for i, device in enumerate(devices, 1):
             connection_status = "Connected" if device.is_connected.value == 1 else "Disconnected"
             print(f"{i:2}. {device.name}")
             print(f"    orb_id: {device.orb_id}")
             print(f"    status: {connection_status}")
             print()
-        
+
         return devices
-        
+
     except Exception as e:
         print(f"Error getting devices: {e}")
         return []
@@ -47,53 +47,69 @@ def select_device(devices: List[Device]) -> Optional[Device]:
     if not devices:
         print("No devices available to select from.")
         return None
-    
+
     while True:
         try:
             choice = input(f"Select a device (1-{len(devices)}) or 'q' to quit: ").strip()
-            
+
             if choice.lower() == 'q':
                 print("Exiting...")
                 return None
-            
+
             device_index = int(choice) - 1
-            
+
             if 0 <= device_index < len(devices):
                 selected_device = devices[device_index]
                 print(f"Selected: {selected_device.name}")
                 return selected_device
             else:
                 print(f"Please enter a number between 1 and {len(devices)}")
-                
+
         except ValueError:
             print("Please enter a valid number or 'q' to quit")
         except KeyboardInterrupt:
             print("\nExiting...")
             return None
 
+def select_device_action() -> Optional[str]:
+    """Determine the device action to perform"""
+    while True:
+        print("1) Enable temp datasets push")
+        print("2) Perform a content speed test")
+        print("3) Perform a top speed test")
+        action = input("Choose an action (1,2,3): ").strip()
+        match action:
+            case "1":
+                return "temp-dataset"
+            case "2":
+                return "speedtest-content"
+            case "3":
+                return "speedtest-top"
+            case _:
+                pass
 
 def get_push_url() -> Optional[str]:
     """Get the push URL from the user."""
     while True:
         try:
             url = input("\nEnter the URL to push data to (or 'q' to quit): ").strip()
-            
+
             if url.lower() == 'q':
                 print("Exiting...")
                 return None
-            
+
             if not url:
                 print("Please enter a valid URL")
                 continue
-            
+
             # Basic URL validation
             if not (url.startswith('http://') or url.startswith('https://')):
                 print("URL should start with http:// or https://")
                 continue
-            
+
             print(f"Will push data to: {url}")
             return url
-            
+
         except KeyboardInterrupt:
             print("\nExiting...")
             return None
@@ -102,7 +118,7 @@ def get_push_url() -> Optional[str]:
 def configure_temp_datasets(client: OrbCloudClient, device_id: str, push_url: str) -> bool:
     """Configure temporary datasets for the specified device."""
     print(f"Configuring temporary datasets for device: {device_id}")
-    
+
     # Create the temporary datasets configuration
     temp_config = TempDatasetsRequest(
         duration="5m",  # Run for 5 minutes
@@ -118,12 +134,12 @@ def configure_temp_datasets(client: OrbCloudClient, device_id: str, push_url: st
             )
         )
     )
-    
+
     try:
         result = client.configure_temporary_datasets(device_id, temp_config)
         print(f"Temporary datasets configured successfully: {result}")
         return True
-        
+
     except Exception as e:
         print(f"Error configuring temporary datasets: {e}")
         return False
@@ -134,50 +150,61 @@ def main():
     # Get configuration from environment variables
     api_token = os.getenv("ORB_API_TOKEN")
     organization_id = os.getenv("ORB_ORGANIZATION_ID")
-    
+
     if not api_token:
         print("Error: Please set ORB_API_TOKEN environment variable")
         sys.exit(1)
-    
+
     if not organization_id:
         print("Error: Please set ORB_ORGANIZATION_ID environment variable")
         sys.exit(1)
-    
+
     print("Orb Cloud API Client Example")
     print("=" * 30)
-    
+
     # Create the client
     with OrbCloudClient(token=api_token) as client:
         # Step 1: Get and display all devices
         devices = get_and_display_devices(client, organization_id)
-        
+
         if not devices:
             print("No devices found. Exiting.")
             sys.exit(1)
-        
+
         # Step 2: Let user select a device
         selected_device = select_device(devices)
-        
+
         if not selected_device:
             sys.exit(0)
-        
-        # Step 3: Get the push URL from user
-        push_url = get_push_url()
-        
-        if not push_url:
-            sys.exit(0)
-        
-        # Step 4: Configure temporary datasets for the selected device
-        success = configure_temp_datasets(client, selected_device.orb_id, push_url)
-        
-        if success:
-            print("\nExample completed successfully!")
-            print(f"Device '{selected_device.name}' is now configured to collect temporary datasets.")
-            print(f"Data will be pushed to: {push_url}")
-        else:
-            print("\nExample failed to configure temporary datasets.")
-            sys.exit(1)
 
+        # Step 3: Determine the action to perform
+        action = select_device_action()
+
+        if action == "temp-dataset":
+            # Step 4a: Get the push URL from user
+            push_url = get_push_url()
+
+            if not push_url:
+                sys.exit(0)
+
+            # Step 5: Configure temporary datasets for the selected device
+            success = configure_temp_datasets(client, selected_device.orb_id, push_url)
+
+            if success:
+                print("\nExample completed successfully!")
+                print(f"Device '{selected_device.name}' is now configured to collect temporary datasets.")
+                print(f"Data will be pushed to: {push_url}")
+            else:
+                print("\nExample failed to configure temporary datasets.")
+                sys.exit(1)
+        elif "speedtest" in action:
+            # Step 4b: Trigger the selected speedtest on the device
+            test_type = action.split('-')[1]
+            try:
+                result = client.trigger_speedtest(selected_device.orb_id, test_type)
+                print(f"Triggered {test_type} speed test on device {selected_device.orb_id}")
+            except Exception as e:
+                print(f"Error triggering speed test: {e}")
 
 if __name__ == "__main__":
     main()

orb_cloud_client-1.3.0/orb_cloud_client/models/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.yaml
+#   timestamp: 2025-11-11T08:49:27+00:00

orb_cloud_client-1.3.0/orb_cloud_client/models/config.py

@@ -0,0 +1,36 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.yaml
+#   timestamp: 2025-11-11T08:49:27+00:00
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class DataAPI(BaseModel):
+    api_key: Optional[str] = None
+    buffer: Optional[int] = None
+    datasets: Optional[List[str]] = None
+    enabled: Optional[bool] = None
+    identifiable: Optional[bool] = None
+    port: Optional[int] = None
+
+
+class DataPush(BaseModel):
+    buffer_kb: Optional[int] = None
+    datasets: Optional[List[str]] = None
+    enabled: Optional[bool] = None
+    format: Optional[str] = None
+    identifiable: Optional[bool] = None
+    interval_ms: Optional[int] = None
+    url: Optional[str] = None
+
+
+class Datasets(BaseModel):
+    api: Optional[DataAPI] = None
+    cloud_push: Optional[DataPush] = None
+    datasets: Optional[List[str]] = None
+    enabled: Optional[bool] = None
+    push: Optional[DataPush] = None

orb_cloud_client-1.3.0/orb_cloud_client/models/db.py

@@ -0,0 +1,26 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.yaml
+#   timestamp: 2025-11-11T08:49:27+00:00
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel
+
+
+class AccountConfigEntitlements(BaseModel):
+    entitlements: Optional[List[str]] = None
+
+
+class AccountPlanLimits(BaseModel):
+    deployment_tokens: Optional[int] = None
+    devices: Optional[int] = None
+    users: Optional[int] = None
+
+
+class AccountPlan(BaseModel):
+    config: Optional[AccountConfigEntitlements] = None
+    features: Optional[List[str]] = None
+    limits: Optional[AccountPlanLimits] = None
+    name: Optional[str] = None

orb_cloud_client-1.2.1/orb_cloud_client/models.py → orb_cloud_client-1.3.0/orb_cloud_client/models/generic.py

@@ -1,6 +1,6 @@
-# generated by datamodel-codegen:
-#   filename:  openapi.yaml
-#   timestamp: 2025-10-16T14:05:24+00:00
+# 20251111 This file is here for historic reasons, and backward compatibility.
+# this can safely be removed in the future if needed. Make sure to validate the
+# imports in other files before doing so.
 
 from __future__ import annotations
 
@@ -9,6 +9,10 @@ from typing import Dict, List, Optional
 
 from pydantic import BaseModel, Field
 
+from .server import OrganizationDeviceResponse, DatasetsRequest, OrganizationsResponse as Organization
+from .db import AccountPlan, AccountPlanLimits, AccountConfigEntitlements # noqa
+from .config import Datasets, DataPush, DataAPI  # noqa
+
 
 class IsConnected(Enum):
     integer_0 = 0
@@ -78,56 +82,8 @@ class OrbScore(BaseModel):
     )
 
 
-class DataPush(BaseModel):
-    enabled: bool = Field(
-        ..., description='Whether data push is enabled', examples=[True]
-    )
-    identifiable: Optional[bool] = Field(
-        None, description='Whether data should be identifiable', examples=[True]
-    )
-    datasets: Optional[List[str]] = Field(
-        None,
-        description='List of datasets to push',
-        examples=[['responsiveness_1s', 'speed_results']],
-    )
-    url: Optional[str] = Field(
-        None,
-        description='URL to push data to',
-        examples=['https://api.example.com/data'],
-    )
-    format: Optional[str] = Field(
-        None, description='Data format for pushing', examples=['json']
-    )
-    buffer_kb: Optional[int] = Field(
-        None, description='Buffer size in KB', examples=[64]
-    )
-    interval_ms: Optional[int] = Field(
-        None, description='Push interval in milliseconds', examples=[5000]
-    )
-
-
-class DataAPI(BaseModel):
-    enabled: bool = Field(
-        ..., description='Whether data API is enabled', examples=[True]
-    )
-    identifiable: Optional[bool] = Field(
-        None, description='Whether data should be identifiable', examples=[True]
-    )
-    datasets: Optional[List[str]] = Field(
-        None,
-        description='List of datasets to expose via API',
-        examples=[['responsiveness_1s', 'speed_results']],
-    )
-    api_key: Optional[str] = Field(
-        None,
-        description='API key for accessing the data API',
-        examples=['your-api-key-here'],
-    )
-    port: Optional[int] = Field(
-        None, description='Port for the data API', examples=[8080]
-    )
-    buffer: Optional[int] = Field(None, description='Buffer size', examples=[1000])
-
+class TriggerSpeedtestRequest(BaseModel):
+    pass
 
 class Error(BaseModel):
     message: str = Field(
@@ -137,43 +93,11 @@ class Error(BaseModel):
         None, description='Error code', examples=['INVALID_ORG_ID']
     )
 
-
-class AccountConfigEntitlements(BaseModel):
-    entitlements: Optional[List[str]] = None
-
-
-class AccountPlanLimits(BaseModel):
-    deployment_tokens: Optional[int] = None
-    devices: Optional[int] = None
-    users: Optional[int] = None
-
-
 class SummaryTags(BaseModel):
     geoip: Optional[GeoIPInfo] = None
     device_info: Optional[DeviceInfo] = None
     network_interface: Optional[NetworkInterface] = None
 
-
-class Datasets(BaseModel):
-    enabled: bool = Field(
-        ..., description='Whether datasets are enabled', examples=[True]
-    )
-    datasets: Optional[List[str]] = Field(
-        None,
-        description='List of datasets to collect',
-        examples=[['responsiveness_1s', 'speed_results']],
-    )
-    cloud_push: Optional[DataPush] = None
-    push: Optional[DataPush] = None
-    api: Optional[DataAPI] = None
-
-
-class AccountPlan(BaseModel):
-    config: Optional[AccountConfigEntitlements] = None
-    features: Optional[List[str]] = None
-    limits: Optional[AccountPlanLimits] = None
-
-
 class DeviceSummary(BaseModel):
     tags: Optional[SummaryTags] = None
     version: Optional[str] = Field(
@@ -187,23 +111,12 @@ class DeviceSummary(BaseModel):
         None, description='Array of Orb scores for different time windows'
     )
 
+class TempDatasetsRequest(DatasetsRequest):
+		duration: str = Field(
+				..., description='Duration for temporary dataset configuration', examples=['1h']
+		)
 
-class TempDatasetsRequest(BaseModel):
-    duration: str = Field(
-        ..., description='Duration for temporary dataset configuration', examples=['1h']
-    )
-    datasets_config: Datasets
-
-
-class Organization(BaseModel):
-    customer_id: Optional[str] = None
-    name: Optional[str] = None
-    organization_id: Optional[str] = None
-    plan: Optional[AccountPlan] = None
-    subscription_id: Optional[str] = None
-
-
-class Device(BaseModel):
+class Device(OrganizationDeviceResponse):
     orb_id: str = Field(
         ...,
         description='Unique Orb device identifier',
@@ -241,5 +154,4 @@ class Device(BaseModel):
         ],
     )
 
-
 OrbScore.model_rebuild()

orb_cloud_client-1.3.0/orb_cloud_client/models/server.py

@@ -0,0 +1,46 @@
+# generated by datamodel-codegen:
+#   filename:  openapi.yaml
+#   timestamp: 2025-11-11T08:49:27+00:00
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, Field
+
+from . import config as config_1
+from . import db
+
+
+class OrganizationDeviceResponse(BaseModel):
+    can_notify: Optional[bool] = None
+    config: Optional[Dict[str, Any]] = Field(
+        None, description='device configuration, if available'
+    )
+    configuration_id: Optional[str] = Field(
+        None, description='device configuration ID, if available'
+    )
+    is_connected: Optional[int] = None
+    is_connected_updated_at: Optional[str] = None
+    name: Optional[str] = None
+    orb_id: Optional[str] = None
+    summary: Optional[Dict[str, Any]] = Field(
+        None, description='last received summary from the device'
+    )
+    tags: Optional[Dict[str, Any]] = Field(
+        None, description='list of tags associated with the device'
+    )
+
+
+class DatasetsRequest(BaseModel):
+    datasets_config: Optional[config_1.Datasets] = None
+    duration: Optional[str] = None
+
+
+class OrganizationsResponse(BaseModel):
+    customer_id: Optional[str] = None
+    name: Optional[str] = None
+    organization_id: Optional[str] = None
+    plan: Optional[db.AccountPlan] = None
+    subscription_id: Optional[str] = None
+    usage: Optional[db.AccountPlanLimits] = None

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0/orb_cloud_client.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: orb-cloud-client
-Version: 1.2.1
+Version: 1.3.0
 Summary: Python client library for Orb Cloud API
 Author-email: Orb Networks <support@orb.net>
-License: MIT
+License-Expression: MIT
 Project-URL: Documentation, https://api.orb.net/docs
 Project-URL: Homepage, https://github.com/orbforge/orb-cloud
 Project-URL: Repository, https://github.com/orbforge/orb-cloud
@@ -21,6 +21,7 @@ License-File: LICENSE
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: httpx>=0.24.0
 Requires-Dist: pydantic>=2.0.0
+Requires-Dist: twine>=6.1.0
 Provides-Extra: dev
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0}/orb_cloud_client.egg-info/SOURCES.txt

@@ -6,10 +6,14 @@ orb_cloud_client/__init__.py
 orb_cloud_client/client.py
 orb_cloud_client/example.py
 orb_cloud_client/example_async.py
-orb_cloud_client/models.py
 orb_cloud_client.egg-info/PKG-INFO
 orb_cloud_client.egg-info/SOURCES.txt
 orb_cloud_client.egg-info/dependency_links.txt
 orb_cloud_client.egg-info/entry_points.txt
 orb_cloud_client.egg-info/requires.txt
-orb_cloud_client.egg-info/top_level.txt
+orb_cloud_client.egg-info/top_level.txt
+orb_cloud_client/models/__init__.py
+orb_cloud_client/models/config.py
+orb_cloud_client/models/db.py
+orb_cloud_client/models/generic.py
+orb_cloud_client/models/server.py

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0}/orb_cloud_client.egg-info/requires.txt

@@ -1,6 +1,7 @@
 build>=1.2.2.post1
 httpx>=0.24.0
 pydantic>=2.0.0
+twine>=6.1.0
 
 [dev]
 build

{orb_cloud_client-1.2.1 → orb_cloud_client-1.3.0}/pyproject.toml

@@ -20,13 +20,14 @@ dependencies = [
   "build>=1.2.2.post1",
   "httpx>=0.24.0",
   "pydantic>=2.0.0",
+  "twine>=6.1.0",
 ]
 description = "Python client library for Orb Cloud API"
-license = {text = "MIT"}
+license = "MIT"
 name = "orb-cloud-client"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "1.2.1"
+version = "1.3.0"
 
 [project.optional-dependencies]
 dev = [