wandelbots_api_client 26.3.0.dev29__tar.gz

wandelbots_api_client-26.3.0.dev29/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: wandelbots_api_client
+Version: 26.3.0.dev29
+Summary: Wandelbots Python Client: Interact with robots in an easy and intuitive way. 
+Author: Copyright (c) 2025 Wandelbots GmbH
+Author-email: Copyright (c) 2025 Wandelbots GmbH <contact@wandelbots.com>
+License-Expression: Apache-2.0
+Classifier: Typing :: Typed
+Classifier: Topic :: Software Development
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Requires-Dist: urllib3>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: aiohttp>=3.8.4
+Requires-Dist: aiohttp-retry>=2.8.3
+Requires-Dist: pydantic>=2
+Requires-Dist: websockets
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: furl
+Requires-Dist: pyhumps
+Requires-Dist: pydantic-core
+Requires-Dist: annotated-types
+Requires-Dist: pydantic[email]
+Requires-Python: >=3.9
+Project-URL: homepage, https://wandelbots.com/
+Description-Content-Type: text/markdown
+
+# wandelbots-api-client
+Interact with robots in an easy and intuitive way.
+
+- Compatible API version: 1.4.0 dev (can be found at the home screen of your instance -> API)
+- Package version: 26.3.0.dev29
+
+## Requirements.
+Python >=3.11, Python < 4.0
+
+## Installation
+
+```bash
+pip install wandelbots-api-client
+```
+
+OR with uv:
+
+```bash
+uv init
+uv add wandelbots-api-client
+```
+
+## Authentication
+
+The SDK supports OAuth2 device code flow authentication for both Entra ID (formerly Azure AD) and Auth0. This authentication method is ideal for CLI applications, scripts, and headless environments.
+
+### Entra ID (Azure AD) Authentication
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import EntraIDConfig
+
+async def main():
+    # Initialize Entra ID config
+    auth = EntraIDConfig(
+        client_id="GIVEN_CLIENT_ID",
+        tenant_id="GIVEN_TENANT_ID", 
+        scope="openid profile email offline_access GIVEN_CLIENT_ID\.default"
+    )
+    
+    # Request device code
+    device_response = await auth.request_device_code()
+    
+    # Display user instructions
+    print(f"\nPlease authenticate:")
+    print(f"1. Go to: {device_response['verification_uri']}")
+    print(f"2. Enter code: {device_response['user_code']}")
+    print(f"Waiting for authentication...\n")
+    
+    # Poll for token (will wait until user completes authentication)
+    token_response = await auth.poll_token_endpoint(
+        device_code=device_response["device_code"],
+        interval=device_response.get("interval", 5),
+        expires_in=device_response.get("expires_in", 900)
+    )
+    
+    print("Authentication successful!")
+    
+    # Configure API client with access token
+    config = Configuration(
+        host="https://your-instance.wandelbots.io",
+        access_token=token_response["access_token"]
+    )
+    
+    async with ApiClient(configuration=config) as api_client:
+        # Use the API client for authenticated requests
+        # Example: api = YourApi(api_client)
+        # result = await api.your_method()
+        pass
+    
+    # Optionally refresh the token later
+    if "refresh_token" in token_response:
+        new_token = await auth.refresh_token(token_response["refresh_token"])
+        config.access_token = new_token["access_token"]
+
+asyncio.run(main())
+```
+
+### Auth0 Authentication
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import Auth0Config
+
+async def main():
+    # Initialize Auth0 config
+    auth = Auth0Config(
+        client_id="GIVEN_CLIENT_ID",
+        domain="auth.portal.wandelbots.io",
+        audience="GIVEN_AUDIENCE", 
+        scope="openid profile email offline_access"
+    )
+    
+    # Or use default config from template variables
+    # auth = Auth0Config.default()
+    
+    # Request device code
+    device_response = await auth.request_device_code()
+    
+    # Display user instructions
+    print(f"\nPlease authenticate:")
+    print(f"1. Go to: {device_response['verification_uri']}")
+    print(f"2. Enter code: {device_response['user_code']}")
+    print(f"Waiting for authentication...\n")
+    
+    # Poll for token (will wait until user completes authentication)
+    token_response = await auth.poll_token_endpoint(
+        device_code=device_response["device_code"],
+        interval=device_response.get("interval", 5),
+        expires_in=device_response.get("expires_in", 900)
+    )
+    
+    print("Authentication successful!")
+    
+    # Configure API client with access token
+    config = Configuration(
+        host="https://XYZ.instances.wandelbots.io",
+        access_token=token_response["access_token"]
+    )
+    
+    async with ApiClient(configuration=config) as api_client:
+        # Use the API client for authenticated requests
+        # Example: api = YourApi(api_client)
+        # result = await api.your_method()
+        pass
+
+asyncio.run(main())
+```
+
+### Token Refresh
+
+To maintain long-lived sessions, use refresh tokens to obtain new access tokens:
+
+```python
+# When your access token expires
+if "refresh_token" in token_response:
+    refreshed = await auth.refresh_token(token_response["refresh_token"])
+    config.access_token = refreshed["access_token"]
+    
+    # Update refresh token if a new one is provided
+    if "refresh_token" in refreshed:
+        token_response["refresh_token"] = refreshed["refresh_token"]
+```
+
+### Complete Example with Error Handling
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import EntraIDConfig
+
+async def authenticate_and_call_api():
+    """Complete example with error handling."""
+    try:
+        # Initialize authentication
+        auth = EntraIDConfig(
+            client_id="GIVEN_CLIENT_ID",
+            tenant_id="GIVEN_TENANT_ID",
+            scopen="openid profile email offline_access GIVEN_CLIENT_ID\.default"
+        )
+        
+        # Verify configuration
+        if not auth.is_complete():
+            raise ValueError("Authentication configuration is incomplete")
+        
+        # Request device code
+        device_response = await auth.request_device_code()
+        
+        # Display instructions
+        print(f"\n{'='*60}")
+        print(f"AUTHENTICATION REQUIRED")
+        print(f"{'='*60}")
+        print(f"Visit: {device_response['verification_uri']}")
+        print(f"Enter code: {device_response['user_code']}")
+        print(f"{'='*60}\n")
+        
+        # Wait for user to authenticate
+        token_response = await auth.poll_token_endpoint(
+            device_code=device_response["device_code"],
+            interval=device_response.get("interval", 5),
+            expires_in=device_response.get("expires_in", 900)
+        )
+        
+        print("✓ Authentication successful!\n")
+        
+        # Create API client
+        config = Configuration(
+            host="https://XYZ.instance.wandelbots.io",
+            access_token=token_response["access_token"]
+        )
+        
+        async with ApiClient(configuration=config) as api_client:
+            # Make authenticated API calls here
+            # Example:
+            # from wandelbots_api_client.api import YourApi
+            # api = YourApi(api_client)
+            # result = await api.your_method()
+            print("API client ready for requests")
+            
+    except TimeoutError:
+        print("Authentication timed out. Please try again.")
+    except ValueError as e:
+        print(f"Configuration error: {e}")
+    except Exception as e:
+        print(f"Authentication failed: {e}")
+
+asyncio.run(authenticate_and_call_api())
+```
+
+

wandelbots_api_client-26.3.0.dev29/README.md

@@ -0,0 +1,212 @@
+# wandelbots-api-client
+Interact with robots in an easy and intuitive way.
+
+- Compatible API version: 1.4.0 dev (can be found at the home screen of your instance -> API)
+- Package version: 26.3.0.dev29
+
+## Requirements.
+Python >=3.11, Python < 4.0
+
+## Installation
+
+```bash
+pip install wandelbots-api-client
+```
+
+OR with uv:
+
+```bash
+uv init
+uv add wandelbots-api-client
+```
+
+## Authentication
+
+The SDK supports OAuth2 device code flow authentication for both Entra ID (formerly Azure AD) and Auth0. This authentication method is ideal for CLI applications, scripts, and headless environments.
+
+### Entra ID (Azure AD) Authentication
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import EntraIDConfig
+
+async def main():
+    # Initialize Entra ID config
+    auth = EntraIDConfig(
+        client_id="GIVEN_CLIENT_ID",
+        tenant_id="GIVEN_TENANT_ID", 
+        scope="openid profile email offline_access GIVEN_CLIENT_ID\.default"
+    )
+    
+    # Request device code
+    device_response = await auth.request_device_code()
+    
+    # Display user instructions
+    print(f"\nPlease authenticate:")
+    print(f"1. Go to: {device_response['verification_uri']}")
+    print(f"2. Enter code: {device_response['user_code']}")
+    print(f"Waiting for authentication...\n")
+    
+    # Poll for token (will wait until user completes authentication)
+    token_response = await auth.poll_token_endpoint(
+        device_code=device_response["device_code"],
+        interval=device_response.get("interval", 5),
+        expires_in=device_response.get("expires_in", 900)
+    )
+    
+    print("Authentication successful!")
+    
+    # Configure API client with access token
+    config = Configuration(
+        host="https://your-instance.wandelbots.io",
+        access_token=token_response["access_token"]
+    )
+    
+    async with ApiClient(configuration=config) as api_client:
+        # Use the API client for authenticated requests
+        # Example: api = YourApi(api_client)
+        # result = await api.your_method()
+        pass
+    
+    # Optionally refresh the token later
+    if "refresh_token" in token_response:
+        new_token = await auth.refresh_token(token_response["refresh_token"])
+        config.access_token = new_token["access_token"]
+
+asyncio.run(main())
+```
+
+### Auth0 Authentication
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import Auth0Config
+
+async def main():
+    # Initialize Auth0 config
+    auth = Auth0Config(
+        client_id="GIVEN_CLIENT_ID",
+        domain="auth.portal.wandelbots.io",
+        audience="GIVEN_AUDIENCE", 
+        scope="openid profile email offline_access"
+    )
+    
+    # Or use default config from template variables
+    # auth = Auth0Config.default()
+    
+    # Request device code
+    device_response = await auth.request_device_code()
+    
+    # Display user instructions
+    print(f"\nPlease authenticate:")
+    print(f"1. Go to: {device_response['verification_uri']}")
+    print(f"2. Enter code: {device_response['user_code']}")
+    print(f"Waiting for authentication...\n")
+    
+    # Poll for token (will wait until user completes authentication)
+    token_response = await auth.poll_token_endpoint(
+        device_code=device_response["device_code"],
+        interval=device_response.get("interval", 5),
+        expires_in=device_response.get("expires_in", 900)
+    )
+    
+    print("Authentication successful!")
+    
+    # Configure API client with access token
+    config = Configuration(
+        host="https://XYZ.instances.wandelbots.io",
+        access_token=token_response["access_token"]
+    )
+    
+    async with ApiClient(configuration=config) as api_client:
+        # Use the API client for authenticated requests
+        # Example: api = YourApi(api_client)
+        # result = await api.your_method()
+        pass
+
+asyncio.run(main())
+```
+
+### Token Refresh
+
+To maintain long-lived sessions, use refresh tokens to obtain new access tokens:
+
+```python
+# When your access token expires
+if "refresh_token" in token_response:
+    refreshed = await auth.refresh_token(token_response["refresh_token"])
+    config.access_token = refreshed["access_token"]
+    
+    # Update refresh token if a new one is provided
+    if "refresh_token" in refreshed:
+        token_response["refresh_token"] = refreshed["refresh_token"]
+```
+
+### Complete Example with Error Handling
+
+```python
+import asyncio
+from wandelbots_api_client import ApiClient, Configuration
+from wandelbots_api_client.authorization import EntraIDConfig
+
+async def authenticate_and_call_api():
+    """Complete example with error handling."""
+    try:
+        # Initialize authentication
+        auth = EntraIDConfig(
+            client_id="GIVEN_CLIENT_ID",
+            tenant_id="GIVEN_TENANT_ID",
+            scopen="openid profile email offline_access GIVEN_CLIENT_ID\.default"
+        )
+        
+        # Verify configuration
+        if not auth.is_complete():
+            raise ValueError("Authentication configuration is incomplete")
+        
+        # Request device code
+        device_response = await auth.request_device_code()
+        
+        # Display instructions
+        print(f"\n{'='*60}")
+        print(f"AUTHENTICATION REQUIRED")
+        print(f"{'='*60}")
+        print(f"Visit: {device_response['verification_uri']}")
+        print(f"Enter code: {device_response['user_code']}")
+        print(f"{'='*60}\n")
+        
+        # Wait for user to authenticate
+        token_response = await auth.poll_token_endpoint(
+            device_code=device_response["device_code"],
+            interval=device_response.get("interval", 5),
+            expires_in=device_response.get("expires_in", 900)
+        )
+        
+        print("✓ Authentication successful!\n")
+        
+        # Create API client
+        config = Configuration(
+            host="https://XYZ.instance.wandelbots.io",
+            access_token=token_response["access_token"]
+        )
+        
+        async with ApiClient(configuration=config) as api_client:
+            # Make authenticated API calls here
+            # Example:
+            # from wandelbots_api_client.api import YourApi
+            # api = YourApi(api_client)
+            # result = await api.your_method()
+            print("API client ready for requests")
+            
+    except TimeoutError:
+        print("Authentication timed out. Please try again.")
+    except ValueError as e:
+        print(f"Configuration error: {e}")
+    except Exception as e:
+        print(f"Authentication failed: {e}")
+
+asyncio.run(authenticate_and_call_api())
+```
+
+

wandelbots_api_client-26.3.0.dev29/pyproject.toml

@@ -0,0 +1,95 @@
+[project]
+name = "wandelbots_api_client"
+version = "26.3.0.dev29"
+description = "Wandelbots Python Client: Interact with robots in an easy and intuitive way. "
+authors = [{ name="Copyright (c) 2025 Wandelbots GmbH", email="contact@wandelbots.com" }]
+license = "Apache-2.0"
+readme = "README.md"
+urls = { homepage = "https://wandelbots.com/" }
+
+classifiers = [
+    'Typing :: Typed',
+    'Topic :: Software Development',
+    'Operating System :: Microsoft :: Windows',
+    'Operating System :: POSIX',
+    'Operating System :: Unix',
+    'Operating System :: MacOS',
+]
+
+requires-python = ">=3.9"
+
+dependencies = [
+  "urllib3 >= 1.25.3",
+  "python-dateutil >=2.8.2",
+  "aiohttp >= 3.8.4",
+  "aiohttp-retry >= 2.8.3",
+  "pydantic >=2",
+  "websockets",
+  "typing-extensions >=4.7.1",
+  "furl",
+  "pyhumps",
+  "pydantic_core",
+  "annotated-types",
+  "pydantic[email]",
+]
+
+[dependency-groups]
+dev = [
+  "pytest>=7.2.1",
+  "types-python-dateutil>=2.8.19.14",
+  "mypy>=1.4.1"
+]
+
+[build-system]
+requires = ["uv_build>=0.10.9,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = ""
+module-name = "wandelbots_api_client"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "wandelbots_api_client",
+  #"test",  # auto-generated tests
+  #"tests", # hand-written tests
+]
+
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = ["furl.*"]
+follow_untyped_imports = true

wandelbots_api_client-26.3.0.dev29/wandelbots_api_client/__init__.py

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 1.4.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+__version__ = "26.3.0.dev29"
+
+from . import models
+from . import api
+from . import api_client
+from . import exceptions
+from . import configuration
+
+from .api import *
+
+# import ApiClient
+from .api_response import ApiResponse
+from .api_client import ApiClient
+from .configuration import Configuration
+from .exceptions import OpenApiException
+from .exceptions import ApiTypeError
+from .exceptions import ApiValueError
+from .exceptions import ApiKeyError
+from .exceptions import ApiAttributeError
+from .exceptions import ApiException
+
+
+__all__ = [
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+]

wandelbots_api_client-26.3.0.dev29/wandelbots_api_client/api/__init__.py

@@ -0,0 +1,63 @@
+# flake8: noqa
+
+# import apis into api package
+from .application_api import ApplicationApi
+from .cell_api import CellApi
+from .controller_api import ControllerApi
+from .controller_ios_api import ControllerIOsApi
+from .coordinate_systems_api import CoordinateSystemsApi
+from .device_configuration_api import DeviceConfigurationApi
+from .library_program_api import LibraryProgramApi
+from .library_program_metadata_api import LibraryProgramMetadataApi
+from .library_recipe_api import LibraryRecipeApi
+from .library_recipe_metadata_api import LibraryRecipeMetadataApi
+from .license_api import LicenseApi
+from .motion_api import MotionApi
+from .motion_group_api import MotionGroupApi
+from .motion_group_infos_api import MotionGroupInfosApi
+from .motion_group_jogging_api import MotionGroupJoggingApi
+from .motion_group_kinematic_api import MotionGroupKinematicApi
+from .program_api import ProgramApi
+from .program_operator_api import ProgramOperatorApi
+from .program_values_api import ProgramValuesApi
+from .store_collision_components_api import StoreCollisionComponentsApi
+from .store_collision_scenes_api import StoreCollisionScenesApi
+from .store_object_api import StoreObjectApi
+from .system_api import SystemApi
+from .version_api import VersionApi
+from .virtual_robot_api import VirtualRobotApi
+from .virtual_robot_behavior_api import VirtualRobotBehaviorApi
+from .virtual_robot_mode_api import VirtualRobotModeApi
+from .virtual_robot_setup_api import VirtualRobotSetupApi
+
+
+__all__ = [
+    "ApplicationApi",
+    "CellApi",
+    "ControllerApi",
+    "ControllerIOsApi",
+    "CoordinateSystemsApi",
+    "DeviceConfigurationApi",
+    "LibraryProgramApi",
+    "LibraryProgramMetadataApi",
+    "LibraryRecipeApi",
+    "LibraryRecipeMetadataApi",
+    "LicenseApi",
+    "MotionApi",
+    "MotionGroupApi",
+    "MotionGroupInfosApi",
+    "MotionGroupJoggingApi",
+    "MotionGroupKinematicApi",
+    "ProgramApi",
+    "ProgramOperatorApi",
+    "ProgramValuesApi",
+    "StoreCollisionComponentsApi",
+    "StoreCollisionScenesApi",
+    "StoreObjectApi",
+    "SystemApi",
+    "VersionApi",
+    "VirtualRobotApi",
+    "VirtualRobotBehaviorApi",
+    "VirtualRobotModeApi",
+    "VirtualRobotSetupApi",
+]