| Name | wyseos-sdk JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Python SDK for WyseOS |
| upload_time | 2025-08-25 05:06:46 |
| 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
mate
ai
agentic web
mutlti agent system
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
pydantic
websockets
PyYAML
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# WyseOS SDK for Python
[](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml)
[](https://www.python.org/downloads/)
[](https://pypi.org/project/wyseos-sdk/)
[](./README.md)
[](./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.
Raw data
{
"_id": null,
"home_page": null,
"name": "wyseos-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "WyseOS, Mate, AI, Agentic Web, Mutlti Agent System",
"author": null,
"author_email": "Wyse <info@wyseos.com>",
"download_url": "https://files.pythonhosted.org/packages/9b/86/d0438e64dd9aab9853ffe62bd79122ce8f73a323a240abd7590ddec8d05b/wyseos_sdk-0.2.0.tar.gz",
"platform": null,
"description": "# WyseOS SDK for Python\n\n[](https://github.com/WyseOS/wyseos-sdk-python/actions/workflows/python-sdk-ci.yml)\n[](https://www.python.org/downloads/)\n[](https://pypi.org/project/wyseos-sdk/)\n[](./README.md)\n[](./LICENSE)\n\nWyseOS SDK Python for interacting with the WyseOS 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 wyseos-sdk\n```\n\n## \ud83d\ude80 Examples\n\nTo help you get started, we've included a collection of ready-to-run examples in the `examples` directory.\n\n### Getting Started\n\nThe `examples/getting_started` directory contains a script demonstrating core features of the SDK. To run it:\n\n1. Navigate to `examples/getting_started`.\n2. Open `mate.yaml` and add your API key.\n3. Run the script: `python example.py`.\n\nFor a more detailed walkthrough, check out the **[Quick Start Guide](./examples/quickstart.md)**.\n\n## \ud83d\udcda Documentation\n\n- **[Installation Guide](./installation.md)**\n- **[Quick Start Guide](./examples/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\n```\n\nLoad configuration:\n\n```python\nfrom wyseos.mate import Client\nfrom wyseos.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 wyseos.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/wyseos-sdk-python\ncd wyseos-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/wyseos-sdk-python/issues\n- Email: support@wyseos.com\n\n## \ud83d\udd17 Links\n\n- PyPI: https://pypi.org/project/wyseos-sdk/\n- API Docs: https://docs.wyseos.com\n- Website: https://wyseos.com\n\n\u2014\n\nReady for production. Build with WyseOS 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 WyseOS",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/WyseOS/wyseos-sdk-python#readme",
"Homepage": "https://github.com/WyseOS/wyseos-sdk-python",
"Issues": "https://github.com/WyseOS/wyseos-sdk-python/issues",
"PyPI": "https://pypi.org/project/wyseos-sdk/",
"Repository": "https://github.com/WyseOS/wyseos-sdk-python"
},
"split_keywords": [
"wyseos",
" mate",
" ai",
" agentic web",
" mutlti agent system"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9cbf6f536bf667ed2f3036324ef38eadf204443fc50de234b02dc3e2c0e3ed2c",
"md5": "f59b6878b16d9cb059b0a279f6dc5734",
"sha256": "952b4c358d0e77c172dd732ccb31fc7be97ee3c8cf7d37a632e8140c4dd0214e"
},
"downloads": -1,
"filename": "wyseos_sdk-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f59b6878b16d9cb059b0a279f6dc5734",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 24114,
"upload_time": "2025-08-25T05:06:44",
"upload_time_iso_8601": "2025-08-25T05:06:44.416640Z",
"url": "https://files.pythonhosted.org/packages/9c/bf/6f536bf667ed2f3036324ef38eadf204443fc50de234b02dc3e2c0e3ed2c/wyseos_sdk-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9b86d0438e64dd9aab9853ffe62bd79122ce8f73a323a240abd7590ddec8d05b",
"md5": "24a366f280b66ba765e02885d3961ffd",
"sha256": "17ebd8c7950680a61634e33659db5b8ccbd451533a2ad7f2d29e74423866da80"
},
"downloads": -1,
"filename": "wyseos_sdk-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "24a366f280b66ba765e02885d3961ffd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 20651,
"upload_time": "2025-08-25T05:06:46",
"upload_time_iso_8601": "2025-08-25T05:06:46.342184Z",
"url": "https://files.pythonhosted.org/packages/9b/86/d0438e64dd9aab9853ffe62bd79122ce8f73a323a240abd7590ddec8d05b/wyseos_sdk-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-25 05:06:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WyseOS",
"github_project": "wyseos-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": "wyseos-sdk"
}
