wandelbots_api_client 26.3.0.dev29__py3-none-any.whl

wandelbots_api_client/v2_pydantic/rest.py

@@ -0,0 +1,188 @@
+# coding: utf-8
+
+"""
+Wandelbots NOVA API
+
+Interact with robots in an easy and intuitive way.
+
+The version of the OpenAPI document: 2.3.0 dev
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+import io
+import json
+import re
+import ssl
+from typing import Optional, Union
+
+import aiohttp
+import aiohttp_retry
+
+from wandelbots_api_client.v2_pydantic.exceptions import ApiException, ApiValueError
+
+RESTResponseType = aiohttp.ClientResponse
+
+ALLOW_RETRY_METHODS = frozenset({"DELETE", "GET", "HEAD", "OPTIONS", "PUT", "TRACE"})
+
+
+class RESTResponse(io.IOBase):
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    async def read(self):
+        if self.data is None:
+            self.data = await self.response.read()
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a CIMultiDictProxy of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a CIMultiDictProxy of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+    def __init__(self, configuration) -> None:
+
+        # maxsize is number of requests to host that are allowed in parallel
+        self.maxsize = configuration.connection_pool_maxsize
+
+        self.ssl_context = ssl.create_default_context(
+            cafile=configuration.ssl_ca_cert,
+            cadata=configuration.ca_cert_data,
+        )
+        if configuration.cert_file:
+            self.ssl_context.load_cert_chain(configuration.cert_file, keyfile=configuration.key_file)
+
+        if not configuration.verify_ssl:
+            self.ssl_context.check_hostname = False
+            self.ssl_context.verify_mode = ssl.CERT_NONE
+
+        self.proxy = configuration.proxy
+        self.proxy_headers = configuration.proxy_headers
+
+        retries = configuration.retries
+        if retries is None:
+            self._effective_retry_options = None
+        elif isinstance(retries, aiohttp_retry.RetryOptionsBase):
+            self._effective_retry_options = retries
+        elif isinstance(retries, int):
+            self._effective_retry_options = aiohttp_retry.ExponentialRetry(
+                attempts=retries, factor=2.0, start_timeout=0.1, max_timeout=120.0
+            )
+        else:
+            self._effective_retry_options = None
+
+        self.pool_manager: Optional[aiohttp.ClientSession] = None
+        self.retry_client: Optional[aiohttp_retry.RetryClient] = None
+
+    async def close(self) -> None:
+        if self.pool_manager:
+            await self.pool_manager.close()
+        if self.retry_client is not None:
+            await self.retry_client.close()
+
+    async def request(self, method, url, headers=None, body=None, post_params=None, _request_timeout=None):
+        """Execute request
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in ["GET", "HEAD", "DELETE", "POST", "PUT", "PATCH", "OPTIONS"]
+
+        if post_params and body:
+            raise ApiValueError("body parameter cannot be used with post_params parameter.")
+
+        post_params = post_params or {}
+        headers = headers or {}
+        # url already contains the URL query string
+        timeout = _request_timeout or 5 * 60
+
+        if "Content-Type" not in headers:
+            headers["Content-Type"] = "application/json"
+
+        args = {"method": method, "url": url, "timeout": timeout, "headers": headers}
+
+        if self.proxy:
+            args["proxy"] = self.proxy
+        if self.proxy_headers:
+            args["proxy_headers"] = self.proxy_headers
+
+        # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+        if method in ["POST", "PUT", "PATCH", "OPTIONS", "DELETE"]:
+            if re.search("json", headers["Content-Type"], re.IGNORECASE):
+                if body is not None:
+                    body = json.dumps(body)
+                args["data"] = body
+            elif headers["Content-Type"] == "application/x-www-form-urlencoded":
+                args["data"] = aiohttp.FormData(post_params)
+            elif headers["Content-Type"] == "multipart/form-data":
+                # must del headers['Content-Type'], or the correct
+                # Content-Type which generated by aiohttp
+                del headers["Content-Type"]
+                data = aiohttp.FormData()
+                for param in post_params:
+                    k, v = param
+                    if isinstance(v, tuple) and len(v) == 3:
+                        data.add_field(k, value=v[1], filename=v[0], content_type=v[2])
+                    else:
+                        # Ensures that dict objects are serialized
+                        if isinstance(v, dict):
+                            v = json.dumps(v)
+                        elif isinstance(v, int):
+                            v = str(v)
+                        data.add_field(k, v)
+                args["data"] = data
+
+            # Pass a `bytes` or `str` parameter directly in the body to support
+            # other content types than Json when `body` argument is provided
+            # in serialized form
+            elif isinstance(body, str) or isinstance(body, bytes):
+                args["data"] = body
+            else:
+                # Cannot generate the request from given parameters
+                msg = """Cannot prepare a request message for provided
+                         arguments. Please check that your arguments match
+                         declared content type."""
+                raise ApiException(status=0, reason=msg)
+
+        pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient]
+
+        # https pool manager
+        if self.pool_manager is None:
+            self.pool_manager = aiohttp.ClientSession(
+                connector=aiohttp.TCPConnector(limit=self.maxsize, ssl=self.ssl_context),
+                trust_env=True,
+            )
+        pool_manager = self.pool_manager
+
+        if self._effective_retry_options is not None and method in ALLOW_RETRY_METHODS:
+            if self.retry_client is None:
+                self.retry_client = aiohttp_retry.RetryClient(client_session=self.pool_manager, retry_options=self._effective_retry_options)
+            pool_manager = self.retry_client
+
+        r = await pool_manager.request(**args)
+
+        return RESTResponse(r)

wandelbots_api_client-26.3.0.dev29.dist-info/METADATA

@@ -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())
+```
+
+