# VoiceOS Python SDK
This python client lets you build with [VoiceOS](https://voiceos.io)
## Installation
You can install the package via pip:
```bash
pip install voiceos
```
## Usage
Import the VoiceOS class from the package:
```python
from voiceos.client import VoiceOS
```
Create a new instance of the VoiceOS class by passing your API key:
```python
voiceos = VoiceOS("your-api-key")
```
Start using the python client to access the [agent](https://docs.voiceos.io/api-reference/agents/get), [calls](https://docs.voiceos.io/api-reference/conversations/get) and [phone numbers](https://docs.voiceos.io/api-reference/phone-numbers/get) resources.
```python
# Get all agents
agents = voiceos.agents.list_agents()
print(agents)
# Get all calls
calls = voiceos.conversations.list_conversations()
print(calls)
# Get all phone numbers
phone_numbers = voiceos.phone_numbers.list_phone_numbers()
print(phone_numbers)
```
## License
```
MIT License
Copyright (c) 2024 WakoAI Inc.
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.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/WakoAi/voiceos-python",
"name": "voiceos",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "VoiceOS, VoiceOS Python ClientSDK, VoiceOS Python",
"author": "WakoAI",
"author_email": "hello@wako.ai",
"download_url": "https://files.pythonhosted.org/packages/51/0a/786e90370996a451a9aa018fb32a3bfb285884962d21bc0cac6ec81232cd/voiceos-0.8.1.3.tar.gz",
"platform": null,
"description": "# VoiceOS Python SDK\n\nThis python client lets you build with [VoiceOS](https://voiceos.io)\n\n## Installation\n\nYou can install the package via pip:\n\n```bash\npip install voiceos\n```\n\n## Usage\n\nImport the VoiceOS class from the package:\n\n```python\nfrom voiceos.client import VoiceOS\n```\n\nCreate a new instance of the VoiceOS class by passing your API key:\n\n```python\nvoiceos = VoiceOS(\"your-api-key\")\n```\n\nStart using the python client to access the [agent](https://docs.voiceos.io/api-reference/agents/get), [calls](https://docs.voiceos.io/api-reference/conversations/get) and [phone numbers](https://docs.voiceos.io/api-reference/phone-numbers/get) resources.\n\n```python\n# Get all agents\nagents = voiceos.agents.list_agents()\nprint(agents)\n\n# Get all calls\ncalls = voiceos.conversations.list_conversations()\nprint(calls)\n\n# Get all phone numbers\nphone_numbers = voiceos.phone_numbers.list_phone_numbers()\nprint(phone_numbers)\n```\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2024 WakoAI Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "VoiceOS Python SDK",
"version": "0.8.1.3",
"project_urls": {
"Homepage": "https://github.com/WakoAi/voiceos-python"
},
"split_keywords": [
"voiceos",
" voiceos python clientsdk",
" voiceos python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5275dfed660fbcd62ff57e36cddd735a532821508377659fdde20da7581506eb",
"md5": "9671c20d1d93d1c9a20bbc3b9b7032d7",
"sha256": "614c21a2832367ad8b56f5fdf5767984a8d8f947183086483ac6000db67b7879"
},
"downloads": -1,
"filename": "voiceos-0.8.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9671c20d1d93d1c9a20bbc3b9b7032d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 120676,
"upload_time": "2024-05-11T22:50:13",
"upload_time_iso_8601": "2024-05-11T22:50:13.796626Z",
"url": "https://files.pythonhosted.org/packages/52/75/dfed660fbcd62ff57e36cddd735a532821508377659fdde20da7581506eb/voiceos-0.8.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "510a786e90370996a451a9aa018fb32a3bfb285884962d21bc0cac6ec81232cd",
"md5": "33a91b51a2bcefae03d03dd0cf818f20",
"sha256": "809d571b135132a828fada62d161fa3a419f5c29117b36182bab82efe4c4cf01"
},
"downloads": -1,
"filename": "voiceos-0.8.1.3.tar.gz",
"has_sig": false,
"md5_digest": "33a91b51a2bcefae03d03dd0cf818f20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58995,
"upload_time": "2024-05-11T22:50:16",
"upload_time_iso_8601": "2024-05-11T22:50:16.335686Z",
"url": "https://files.pythonhosted.org/packages/51/0a/786e90370996a451a9aa018fb32a3bfb285884962d21bc0cac6ec81232cd/voiceos-0.8.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-11 22:50:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WakoAi",
"github_project": "voiceos-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.25.3"
],
[
"<",
"2.1.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
}
],
"tox": true,
"lcname": "voiceos"
}
JSON
