wyseos-sdk 0.2.0__tar.gz

wyseos_sdk-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WyseOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wyseos_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: wyseos-sdk
+Version: 0.2.0
+Summary: Python SDK for WyseOS
+Author-email: Wyse <info@wyseos.com>
+License: MIT License
+        
+        Copyright (c) 2025 WyseOS
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/WyseOS/wyseos-sdk-python
+Project-URL: Repository, https://github.com/WyseOS/wyseos-sdk-python
+Project-URL: Issues, https://github.com/WyseOS/wyseos-sdk-python/issues
+Project-URL: Documentation, https://github.com/WyseOS/wyseos-sdk-python#readme
+Project-URL: PyPI, https://pypi.org/project/wyseos-sdk/
+Keywords: WyseOS,Mate,AI,Agentic Web,Mutlti Agent System
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: websockets>=11.0.0
+Requires-Dist: PyYAML>=6.0.0
+Dynamic: license-file
+
+# WyseOS SDK for Python
+
+[![Python SDK CI/CD](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml/badge.svg)](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml)
+[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![PyPI Package](https://img.shields.io/badge/PyPI-wyseos--sdk-blue)](https://pypi.org/project/wyseos-sdk/)
+[![Documentation](https://img.shields.io/badge/docs-comprehensive-green)](./README.md)
+[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
+
+WyseOS SDK Python for interacting with the WyseOS API. Built with modern Python practices, type safety, and real-time support.
+
+## 🚀 Features
+
+- **🎯 Type Safe**: Pydantic models and validation
+- **⚡ Real-time**: WebSocket client
+- **🔧 Simple Config**: YAML config file support
+- **🛡️ Robust Errors**: Clear, structured exceptions
+
+## 📦 Installation
+
+```bash
+pip install wyseos-sdk
+```
+
+## 🚀 Examples
+
+To help you get started, we've included a collection of ready-to-run examples in the `examples` directory.
+
+### Getting Started
+
+The `examples/getting_started` directory contains a script demonstrating core features of the SDK. To run it:
+
+1.  Navigate to `examples/getting_started`.
+2.  Open `mate.yaml` and add your API key.
+3.  Run the script: `python example.py`.
+
+For a more detailed walkthrough, check out the **[Quick Start Guide](./examples/quickstart.md)**.
+
+## 📚 Documentation
+
+- **[Installation Guide](./installation.md)**
+- **[Quick Start Guide](./examples/quickstart.md)**
+
+## 🔧 Configuration
+
+Create `mate.yaml`:
+
+```yaml
+api_key: "your-api-key"
+base_url: "https://api.mate.wyseos.com"
+timeout: 30
+```
+
+Load configuration:
+
+```python
+from wyseos.mate import Client
+from wyseos.mate.config import load_config
+
+client = Client(load_config("mate.yaml"))
+```
+
+## 🌟 Client Services
+
+- `client.user` — API key management
+- `client.team` — Team retrieval
+- `client.agent` — Agent retrieval
+- `client.session` — Session create/info/messages
+- `client.browser` — Browser info/pages/release
+
+## 🧩 Models and Pagination
+
+- `ListOptions(page_num, page_size)`
+- Most list endpoints return `PaginatedResponse[T]` with `data`, `total`, `page_num`, `page_size`, `total_page`.
+
+## 🔌 WebSocket
+
+```python
+from wyseos.mate.websocket import WebSocketClient, MessageType
+
+ws = WebSocketClient(base_url=client.base_url, api_key=client.api_key, session_id="your-session-id")
+ws.set_connect_handler(lambda: print("Connected"))
+ws.set_disconnect_handler(lambda: print("Disconnected"))
+ws.set_message_handler(lambda m: print(m))
+ws.connect("your-session-id")
+
+# Start a task
+ws.send_message({
+    "type": MessageType.START,
+    "data": {
+        "messages": [{"type": "task", "content": "Do something"}],
+        "attachments": [],
+        "team_id": "your-team-id",
+        "kb_ids": [],
+    },
+})
+```
+
+## 🛠️ Development
+
+```bash
+# Clone repository
+git clone https://github.com/WyseOS/wyseos-sdk-python
+cd wyseos-sdk-python
+
+# Install in development mode
+pip install -e .
+
+# Optional development tools
+pip install pytest pytest-cov black isort flake8 mypy
+```
+
+## 📊 Project Status
+
+- Core implementation: ✅
+- Documentation: ✅
+- Tests: 🚧
+
+## 🤝 Contributing
+
+1. Fork
+2. Create a branch
+3. Commit
+4. Push
+5. Open a PR
+
+## 📄 License
+
+MIT License — see `LICENSE`.
+
+## 🆘 Support
+
+- Issues: https://github.com/WyseOS/wyseos-sdk-python/issues
+- Email: support@wyseos.com
+
+## 🔗 Links
+
+- PyPI: https://pypi.org/project/wyseos-sdk/
+- API Docs: https://docs.wyseos.com
+- Website: https://wyseos.com
+
+—
+
+Ready for production. Build with WyseOS SDK Python.

wyseos_sdk-0.2.0/README.md

@@ -0,0 +1,143 @@
+# WyseOS SDK for Python
+
+[![Python SDK CI/CD](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml/badge.svg)](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml)
+[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
+[![PyPI Package](https://img.shields.io/badge/PyPI-wyseos--sdk-blue)](https://pypi.org/project/wyseos-sdk/)
+[![Documentation](https://img.shields.io/badge/docs-comprehensive-green)](./README.md)
+[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
+
+WyseOS SDK Python for interacting with the WyseOS API. Built with modern Python practices, type safety, and real-time support.
+
+## 🚀 Features
+
+- **🎯 Type Safe**: Pydantic models and validation
+- **⚡ Real-time**: WebSocket client
+- **🔧 Simple Config**: YAML config file support
+- **🛡️ Robust Errors**: Clear, structured exceptions
+
+## 📦 Installation
+
+```bash
+pip install wyseos-sdk
+```
+
+## 🚀 Examples
+
+To help you get started, we've included a collection of ready-to-run examples in the `examples` directory.
+
+### Getting Started
+
+The `examples/getting_started` directory contains a script demonstrating core features of the SDK. To run it:
+
+1.  Navigate to `examples/getting_started`.
+2.  Open `mate.yaml` and add your API key.
+3.  Run the script: `python example.py`.
+
+For a more detailed walkthrough, check out the **[Quick Start Guide](./examples/quickstart.md)**.
+
+## 📚 Documentation
+
+- **[Installation Guide](./installation.md)**
+- **[Quick Start Guide](./examples/quickstart.md)**
+
+## 🔧 Configuration
+
+Create `mate.yaml`:
+
+```yaml
+api_key: "your-api-key"
+base_url: "https://api.mate.wyseos.com"
+timeout: 30
+```
+
+Load configuration:
+
+```python
+from wyseos.mate import Client
+from wyseos.mate.config import load_config
+
+client = Client(load_config("mate.yaml"))
+```
+
+## 🌟 Client Services
+
+- `client.user` — API key management
+- `client.team` — Team retrieval
+- `client.agent` — Agent retrieval
+- `client.session` — Session create/info/messages
+- `client.browser` — Browser info/pages/release
+
+## 🧩 Models and Pagination
+
+- `ListOptions(page_num, page_size)`
+- Most list endpoints return `PaginatedResponse[T]` with `data`, `total`, `page_num`, `page_size`, `total_page`.
+
+## 🔌 WebSocket
+
+```python
+from wyseos.mate.websocket import WebSocketClient, MessageType
+
+ws = WebSocketClient(base_url=client.base_url, api_key=client.api_key, session_id="your-session-id")
+ws.set_connect_handler(lambda: print("Connected"))
+ws.set_disconnect_handler(lambda: print("Disconnected"))
+ws.set_message_handler(lambda m: print(m))
+ws.connect("your-session-id")
+
+# Start a task
+ws.send_message({
+    "type": MessageType.START,
+    "data": {
+        "messages": [{"type": "task", "content": "Do something"}],
+        "attachments": [],
+        "team_id": "your-team-id",
+        "kb_ids": [],
+    },
+})
+```
+
+## 🛠️ Development
+
+```bash
+# Clone repository
+git clone https://github.com/WyseOS/wyseos-sdk-python
+cd wyseos-sdk-python
+
+# Install in development mode
+pip install -e .
+
+# Optional development tools
+pip install pytest pytest-cov black isort flake8 mypy
+```
+
+## 📊 Project Status
+
+- Core implementation: ✅
+- Documentation: ✅
+- Tests: 🚧
+
+## 🤝 Contributing
+
+1. Fork
+2. Create a branch
+3. Commit
+4. Push
+5. Open a PR
+
+## 📄 License
+
+MIT License — see `LICENSE`.
+
+## 🆘 Support
+
+- Issues: https://github.com/WyseOS/wyseos-sdk-python/issues
+- Email: support@wyseos.com
+
+## 🔗 Links
+
+- PyPI: https://pypi.org/project/wyseos-sdk/
+- API Docs: https://docs.wyseos.com
+- Website: https://wyseos.com
+
+—
+
+Ready for production. Build with WyseOS SDK Python.

wyseos_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "wyseos-sdk"
+version = "0.2.0"
+description = "Python SDK for WyseOS"
+authors = [{ name = "Wyse", email = "info@wyseos.com" }]
+requires-python = ">=3.9"
+keywords = ["WyseOS", "Mate", "AI", "Agentic Web", "Mutlti Agent System"]
+dependencies = [
+    "requests>=2.31.0",
+    "pydantic>=2.0.0",
+    "websockets>=11.0.0",
+    "PyYAML>=6.0.0",
+]
+
+
+[project.urls]
+Homepage = "https://github.com/WyseOS/wyseos-sdk-python"
+Repository = "https://github.com/WyseOS/wyseos-sdk-python"
+Issues = "https://github.com/WyseOS/wyseos-sdk-python/issues"
+Documentation = "https://github.com/WyseOS/wyseos-sdk-python#readme"
+PyPI = "https://pypi.org/project/wyseos-sdk/"
+
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.license]
+file = "LICENSE"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["wyseos*"]

wyseos_sdk-0.2.0/setup.cfg

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

wyseos_sdk-0.2.0/wyseos/mate/__init__.py

@@ -0,0 +1,22 @@
+"""
+WyseOS Mate Python SDK
+"""
+
+__version__ = "0.2.0"
+__author__ = "Wyse"
+__email__ = "info@wyseos.com"
+
+# Import main classes for easy access
+from .client import Client
+from .config import ClientOptions
+from .errors import APIError, ConfigError, NetworkError, ValidationError, WebSocketError
+
+__all__ = [
+    "Client",
+    "ClientOptions",
+    "APIError",
+    "ValidationError",
+    "NetworkError",
+    "WebSocketError",
+    "ConfigError",
+]

wyseos_sdk-0.2.0/wyseos/mate/client.py

@@ -0,0 +1,156 @@
+"""
+Core API client for the WyseOS Python SDK.
+"""
+
+from typing import Dict, Optional, Type, TypeVar
+from urllib.parse import urlencode, urljoin
+
+import requests
+from pydantic import BaseModel
+
+from .config import ClientOptions
+from .constants import (
+    CONTENT_TYPE_JSON,
+    DEFAULT_BASE_URL,
+    DEFAULT_TIMEOUT,
+    HEADER_ACCEPT,
+    HEADER_API_KEY,
+    HEADER_CONTENT_TYPE,
+    HEADER_USER_AGENT,
+)
+from .errors import APIError
+from .services.agent import AgentService
+from .services.browser import BrowserService
+from .services.session import SessionService
+from .services.team import TeamService
+from .services.user import UserService
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class Client:
+    """Main API client for the WyseOS."""
+
+    def __init__(self, options: Optional[ClientOptions] = None):
+        if options is None:
+            options = ClientOptions()
+
+        self.base_url = options.base_url or DEFAULT_BASE_URL
+        self.api_key = options.api_key
+        self.timeout = options.timeout or DEFAULT_TIMEOUT
+        self.user_agent = "WyseOSPython/0.2.0"  # Set user_agent directly
+        self.http_client = requests.Session()
+
+        # Initialize services
+        self.user = UserService(self)
+        self.team = TeamService(self)
+        self.agent = AgentService(self)
+        self.session = SessionService(self)
+        self.browser = BrowserService(self)
+
+    def _do_request(
+        self, method: str, endpoint: str, body: Optional[Dict] = None
+    ) -> requests.Response:
+        url = urljoin(self.base_url, endpoint)
+
+        headers = {
+            HEADER_CONTENT_TYPE: CONTENT_TYPE_JSON,
+            HEADER_USER_AGENT: self.user_agent,
+            HEADER_ACCEPT: CONTENT_TYPE_JSON,
+        }
+
+        if self.api_key:
+            headers[HEADER_API_KEY] = self.api_key
+
+        try:
+            response = self.http_client.request(
+                method=method, url=url, headers=headers, json=body, timeout=self.timeout
+            )
+
+            if response.status_code != 200:
+                raise APIError(
+                    message="Request failed", status_code=response.status_code
+                )
+
+            return response
+
+        except requests.exceptions.RequestException as e:
+            from .errors import NetworkError
+
+            raise NetworkError(
+                f"Network error during {method} request to {url}: {str(e)}", cause=e
+            )
+
+    def get(
+        self,
+        endpoint: str,
+        result_model: Type[T],
+        params: Optional[Dict[str, str]] = None,
+    ) -> T:
+        if params:
+            endpoint = self._build_url(endpoint, params)
+        response = self._do_request("GET", endpoint)
+        if result_model is dict:
+            return response.json()
+        return result_model.model_validate(response.json())
+
+    def get_paginated(
+        self,
+        endpoint: str,
+        result_model: Type[T],
+        params: Optional[Dict[str, str]] = None,
+    ) -> T:
+        if params:
+            endpoint = self._build_url(endpoint, params)
+
+        response = self._do_request("GET", endpoint)
+        response_data = response.json()
+
+        if "code" in response_data and "data" in response_data:
+            api_response = response_data
+            if api_response.get("code") != 0:
+                message = api_response.get("msg", "Unknown error")
+                raise APIError(message=message, code=api_response.get("code"))
+
+            data = api_response.get("data", {})
+            return result_model.model_validate(data)
+        else:
+            return result_model.model_validate(response_data)
+
+    def post(
+        self,
+        endpoint: str,
+        body: Optional[Dict] = None,
+        result_model: Optional[Type[T]] = None,
+    ) -> Optional[T]:
+        response = self._do_request("POST", endpoint, body)
+        if result_model and response.content:
+            if result_model is dict:
+                return response.json()
+            return result_model.model_validate(response.json())
+        return None
+
+    def put(
+        self,
+        endpoint: str,
+        body: Optional[Dict] = None,
+        result_model: Optional[Type[T]] = None,
+    ) -> Optional[T]:
+        response = self._do_request("PUT", endpoint, body)
+        if result_model and response.content:
+            if result_model is dict:
+                return response.json()
+            return result_model.model_validate(response.json())
+        return None
+
+    def delete(self, endpoint: str) -> None:
+        self._do_request("DELETE", endpoint)
+
+    def _build_url(self, endpoint: str, params: Dict[str, str]) -> str:
+        if not params:
+            return endpoint
+
+        query_string = urlencode(params)
+        separator = "&" if "?" in endpoint else "?"
+
+        return f"{endpoint}{separator}{query_string}"

wyseos_sdk-0.2.0/wyseos/mate/config.py

@@ -0,0 +1,100 @@
+"""
+Configuration management for the WyseOS Python SDK.
+"""
+
+from pathlib import Path
+from typing import Optional, TypeVar, Union
+
+try:
+    import yaml
+except ImportError:
+    raise ImportError(
+        "PyYAML is required for configuration file support. "
+        "Install it with: pip install pyyaml"
+    )
+from pydantic import BaseModel, Field, validator
+
+from .constants import (
+    DEFAULT_BASE_URL,
+    DEFAULT_CONFIG_FILE,
+    DEFAULT_TIMEOUT,
+)
+from .errors import ConfigError
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class ClientOptions(BaseModel):
+    """Configuration options for the WyseOS client."""
+
+    api_key: Optional[str] = Field(
+        default=None,
+        min_length=1,
+    )
+    base_url: str = Field(
+        default=DEFAULT_BASE_URL,
+        min_length=1,
+    )
+    timeout: int = Field(
+        default=DEFAULT_TIMEOUT,
+        ge=1,
+        le=300,
+    )
+
+    class Config:
+        extra = "forbid"
+        validate_assignment = True
+
+    @validator("base_url")
+    def validate_base_url(cls, v):
+        if v is not None:
+            if not v.startswith(("http://", "https://")):
+                raise ValueError("Base URL must start with http:// or https://")
+            if v.endswith("/"):
+                v = v.rstrip("/")
+        return v
+
+    @validator("api_key")
+    def validate_api_key(cls, v):
+        if v is not None:
+            if len(v.strip()) == 0:
+                raise ValueError("API key cannot be empty")
+        return v
+
+
+def load_config(config_path: Optional[Union[str, Path]] = None) -> ClientOptions:
+    if config_path is None:
+        config_path = Path.cwd() / DEFAULT_CONFIG_FILE
+    else:
+        config_path = Path(config_path)
+
+    if not config_path.exists():
+        raise ConfigError(f"Configuration file not found: {config_path}")
+
+    if not config_path.is_file():
+        raise ConfigError(f"Configuration path is not a file: {config_path}")
+
+    try:
+        with open(config_path, "r", encoding="utf-8") as f:
+            content = f.read()
+
+        try:
+            config_data = yaml.safe_load(content)
+        except yaml.YAMLError as e:
+            raise ConfigError(f"Invalid YAML in configuration file: {e}", cause=e)
+
+        if not isinstance(config_data, dict):
+            raise ConfigError("Configuration file must contain a YAML dictionary")
+
+        # If a 'mate' key exists at the top level, use that as the config dict
+        if "mate" in config_data and isinstance(config_data["mate"], dict):
+            config_data = config_data["mate"]
+
+        return ClientOptions(**config_data)
+
+    except IOError as e:
+        raise ConfigError(f"Unable to read configuration file: {e}", cause=e)
+    except Exception as e:
+        if isinstance(e, ConfigError):
+            raise
+        raise ConfigError(f"Unexpected error loading configuration: {e}", cause=e)