| Name | wyse-mate-sdk JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | Python SDK for Wyse Mate |
| upload_time | 2025-08-08 09:25:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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.
|
| keywords |
wyseos
wysemate
ai
agentic web
mutlti agent system
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
pydantic
websockets
PyYAML
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Mate SDK Python
[](https://github.com/WyseOS/mate-sdk-python/actions/workflows/python-sdk-ci.yml)
[](https://www.python.org/downloads/)
[](https://pypi.org/project/wyse-mate-sdk/)
[](./README.md)
[](./LICENSE)
Mate SDK Python for interacting with the Mate 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 wyse-mate-sdk
```
## 🏃♂️ Quick Start
```python
from wyse_mate import Client, ClientOptions
from wyse_mate.config import load_config
# Initialize using mate.yaml (in CWD)
client = Client(load_config())
# List teams
from wyse_mate.models import ListOptions
teams = client.team.get_list(options=ListOptions(page_num=1, page_size=10))
print(f"Found {teams.total} teams")
# Create a session and read messages
from wyse_mate.models import CreateSessionRequest
session = client.session.create(CreateSessionRequest(team_id="your-team-id", task="My task"))
info = client.session.get_info(session.session_id)
msgs = client.session.get_messages(session.session_id, page_num=1, page_size=20)
print(info.status, msgs.total_count)
# WebSocket (Real Time)
from wyse_mate.websocket import WebSocketClient
ws = WebSocketClient(base_url=client.base_url, api_key=client.api_key, session_id=info.session_id)
ws.set_message_handler(lambda m: print(m))
ws.connect(info.session_id)
```
## 📚 Documentation
- **[Installation Guide](./installation.md)**
- **[Quick Start Guide](./quickstart.md)**
## 🔧 Configuration
Create `mate.yaml`:
```yaml
api_key: "your-api-key"
base_url: "https://api.mate.wyseos.com"
timeout: 30
debug: false
```
Load configuration:
```python
from wyse_mate import Client
from wyse_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 wyse_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/mate-sdk-python
cd mate-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/mate-sdk-python/issues
- Email: support@wyseos.com
## 🔗 Links
- PyPI: https://pypi.org/project/wyse-mate-sdk/
- API Docs: https://docs.wyseos.com
- Website: https://wyseos.com
—
Ready for production. Build with Mate SDK Python.
Raw data
{
"_id": null,
"home_page": null,
"name": "wyse-mate-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "WyseOS, WyseMate, AI, Agentic Web, Mutlti Agent System",
"author": null,
"author_email": "Wyse <info@wyseos.com>",
"download_url": "https://files.pythonhosted.org/packages/3a/8b/45a3891f6d465041856e73b1b535012eb17ba13aa700e1a54d3715330776/wyse_mate_sdk-0.1.2.tar.gz",
"platform": null,
"description": "# Mate SDK Python \n\n[](https://github.com/WyseOS/mate-sdk-python/actions/workflows/python-sdk-ci.yml)\n[](https://www.python.org/downloads/)\n[](https://pypi.org/project/wyse-mate-sdk/)\n[](./README.md)\n[](./LICENSE)\n\nMate SDK Python for interacting with the Mate API. Built with modern Python practices, type safety, and real-time support.\n\n## \ud83d\ude80 Features\n\n- **\ud83c\udfaf Type Safe**: Pydantic models and validation\n- **\u26a1 Real-time**: WebSocket client\n- **\ud83d\udd27 Simple Config**: YAML config file support\n- **\ud83d\udee1\ufe0f Robust Errors**: Clear, structured exceptions\n\n## \ud83d\udce6 Installation\n\n```bash\npip install wyse-mate-sdk\n```\n\n## \ud83c\udfc3\u200d\u2642\ufe0f Quick Start\n\n```python\nfrom wyse_mate import Client, ClientOptions\nfrom wyse_mate.config import load_config\n\n# Initialize using mate.yaml (in CWD)\nclient = Client(load_config())\n\n# List teams\nfrom wyse_mate.models import ListOptions\nteams = client.team.get_list(options=ListOptions(page_num=1, page_size=10))\nprint(f\"Found {teams.total} teams\")\n\n# Create a session and read messages\nfrom wyse_mate.models import CreateSessionRequest\nsession = client.session.create(CreateSessionRequest(team_id=\"your-team-id\", task=\"My task\"))\ninfo = client.session.get_info(session.session_id)\nmsgs = client.session.get_messages(session.session_id, page_num=1, page_size=20)\nprint(info.status, msgs.total_count)\n\n# WebSocket (Real Time)\nfrom wyse_mate.websocket import WebSocketClient\nws = WebSocketClient(base_url=client.base_url, api_key=client.api_key, session_id=info.session_id)\nws.set_message_handler(lambda m: print(m))\nws.connect(info.session_id)\n```\n\n## \ud83d\udcda Documentation\n\n- **[Installation Guide](./installation.md)**\n- **[Quick Start Guide](./quickstart.md)**\n\n## \ud83d\udd27 Configuration\n\nCreate `mate.yaml`:\n\n```yaml\napi_key: \"your-api-key\"\nbase_url: \"https://api.mate.wyseos.com\"\ntimeout: 30\ndebug: false\n```\n\nLoad configuration:\n\n```python\nfrom wyse_mate import Client\nfrom wyse_mate.config import load_config\n\nclient = Client(load_config(\"mate.yaml\"))\n```\n\n## \ud83c\udf1f Client Services\n\n- `client.user` \u2014 API key management\n- `client.team` \u2014 Team retrieval\n- `client.agent` \u2014 Agent retrieval\n- `client.session` \u2014 Session create/info/messages\n- `client.browser` \u2014 Browser info/pages/release\n\n## \ud83e\udde9 Models and Pagination\n\n- `ListOptions(page_num, page_size)`\n- Most list endpoints return `PaginatedResponse[T]` with `data`, `total`, `page_num`, `page_size`, `total_page`.\n\n## \ud83d\udd0c WebSocket\n\n```python\nfrom wyse_mate.websocket import WebSocketClient, MessageType\n\nws = WebSocketClient(base_url=client.base_url, api_key=client.api_key, session_id=\"your-session-id\")\nws.set_connect_handler(lambda: print(\"Connected\"))\nws.set_disconnect_handler(lambda: print(\"Disconnected\"))\nws.set_message_handler(lambda m: print(m))\nws.connect(\"your-session-id\")\n\n# Start a task\nws.send_message({\n \"type\": MessageType.START,\n \"data\": {\n \"messages\": [{\"type\": \"task\", \"content\": \"Do something\"}],\n \"attachments\": [],\n \"team_id\": \"your-team-id\",\n \"kb_ids\": [],\n },\n})\n```\n\n## \ud83d\udee0\ufe0f Development\n\n```bash\n# Clone repository\ngit clone https://github.com/WyseOS/mate-sdk-python\ncd mate-sdk-python\n\n# Install in development mode\npip install -e .\n\n# Optional development tools\npip install pytest pytest-cov black isort flake8 mypy\n```\n\n## \ud83d\udcca Project Status\n\n- Core implementation: \u2705\n- Documentation: \u2705\n- Tests: \ud83d\udea7\n\n## \ud83e\udd1d Contributing\n\n1. Fork\n2. Create a branch\n3. Commit\n4. Push\n5. Open a PR\n\n## \ud83d\udcc4 License\n\nMIT License \u2014 see `LICENSE`.\n\n## \ud83c\udd98 Support\n\n- Issues: https://github.com/WyseOS/mate-sdk-python/issues\n- Email: support@wyseos.com\n\n## \ud83d\udd17 Links\n\n- PyPI: https://pypi.org/project/wyse-mate-sdk/\n- API Docs: https://docs.wyseos.com\n- Website: https://wyseos.com\n\n\u2014\n\nReady for production. Build with Mate SDK Python.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 WyseOS\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Python SDK for Wyse Mate",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://github.com/WyseOS/mate-sdk-python#readme",
"Homepage": "https://github.com/WyseOS/mate-sdk-python",
"Issues": "https://github.com/WyseOS/mate-sdk-python/issues",
"PyPI": "https://pypi.org/project/wyse-mate-sdk/",
"Repository": "https://github.com/WyseOS/mate-sdk-python"
},
"split_keywords": [
"wyseos",
" wysemate",
" ai",
" agentic web",
" mutlti agent system"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "baedaa9c01b8d8d5126d0dd4b8aea24dbdff8403e69a4d06605158a32540e850",
"md5": "5ba900484b48c6b73677684ef96ce192",
"sha256": "6f2e53f9a74162bd2239648095c5beb4547d3984585972d4fe82ca0f6c654fc5"
},
"downloads": -1,
"filename": "wyse_mate_sdk-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ba900484b48c6b73677684ef96ce192",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23970,
"upload_time": "2025-08-08T09:25:44",
"upload_time_iso_8601": "2025-08-08T09:25:44.508385Z",
"url": "https://files.pythonhosted.org/packages/ba/ed/aa9c01b8d8d5126d0dd4b8aea24dbdff8403e69a4d06605158a32540e850/wyse_mate_sdk-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3a8b45a3891f6d465041856e73b1b535012eb17ba13aa700e1a54d3715330776",
"md5": "7b8453f433a7e05f68d7937290307f53",
"sha256": "5f6ebebdca2645c21c84093a4dd356660884df61a48e52d43efeaee91fb914fb"
},
"downloads": -1,
"filename": "wyse_mate_sdk-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "7b8453f433a7e05f68d7937290307f53",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20653,
"upload_time": "2025-08-08T09:25:45",
"upload_time_iso_8601": "2025-08-08T09:25:45.813090Z",
"url": "https://files.pythonhosted.org/packages/3a/8b/45a3891f6d465041856e73b1b535012eb17ba13aa700e1a54d3715330776/wyse_mate_sdk-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-08 09:25:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WyseOS",
"github_project": "mate-sdk-python#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.31.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "websockets",
"specs": [
[
">=",
"11.0.0"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"6.0.0"
]
]
}
],
"lcname": "wyse-mate-sdk"
}
