| Name | odins-spear JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Python package for Odin's API to build and manage Broadworks installations. |
| upload_time | 2025-01-24 13:09:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2023 Jordan Prescott 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 |
broadworks
odin
api
telephony
voip
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ⚔️ Odin's Spear
Officially adopted by [Fourteen IP Communications](https://fourteenip.com/) leading supplier of hosted telephony in the hospitality industry.
[](https://pepy.tech/project/odins-spear)
[](https://pepy.tech/project/odins-spear)
[](https://pepy.tech/project/odins-spear)
## Overview
Odin's Spear is a Python library designed to streamline and enhance your experience with Odin's API by [Rev.io](https://www.rev.io/blog/solutions/rev-io-odin-api). If you've worked with BroadWorks for years and struggled with its outdated interface and limitations, Odin's API feels like a breath of fresh air—offering a modern user interface, automation, and comprehensive API access.
With Odin's Spear, managing users, hunt groups, call centers, and other telecom operations becomes significantly easier. This library encapsulates Odin's API functionality, making it accessible, efficient, and user-friendly.
## Features
- **Bulk User Management:** Create and manage thousands of users, hunt groups, and call centers in minutes.
- **Error Handling:** Automatically manage authentication, request design, and error handling.
- **Advanced Tools:** Features like call flow visualization, group audit reports, and bulk management of telecom entities.
- **Alias Assignment Locator:** The first feature release addresses a long-standing issue by allowing you to easily locate where an alias is assigned within BroadWorks—saving you time and frustration.
## Why Odin's Spear?
Working with BroadWorks for over five years was a challenge, with its 90s-style UI and rigid functionality. When Rev.io introduced Odin, with its modern interface and API, it revolutionized how telecom management could be done. However, even with these advancements, some tasks remained cumbersome, like locating alias assignments.
Odin's Spear is the solution. It simplifies your workflow by automating repetitive tasks, handling errors, and making API interactions as smooth as possible. Whether you're managing 10 users or 10,000, Odin's Spear has you covered.
## 🚀 Getting Started
### Prerequisites
- Python 3.12+
- An Odin account
### Installation
Install Odin's Spear using pip:
```bash
pip install odins-spear
```
### Basic Usage
Here's a simple example to get you started:
```python
from odins_spear import API, Scripter, Reporter
# Initialize the API with your credentials
my_api = API(base_url="https://base_url/api/vx", username="john.smith", password="Your Password")
my_api.authenticate()
my_assistant = Scripter(my_api)
# Locate an alias assignment
alias_info = my_assistant.find_alias('ServiceProviderID', 'GroupID', alias=0)
my_assitant = Reporter(my_api)
# Generate call flow visual
my_assistant.call_flow(
'serviceProviderId',
'groupId',
'3001',
'extension',
'auto_attendant'
)
```
For more detailed usage and examples, check out our [Documentation](#-documentation).
## 📖 Documentation
We provide extensive documentation to help you get started quickly and take full advantage of Odin's Spear's capabilities:
- [Odin's Spear Documentation](https://docs.jordan-prescott.com/odins_spear)
## Contributing
We welcome contributions! If you'd like to contribute, please fork the project, make your changes then submit a pull request.
For issues to work on please see our [project](https://github.com/users/Jordan-Prescott/projects/2).
## License
This project is licensed under the MIT License—see the [LICENSE.md](LICENSE) file for details.
## Support
If you encounter any issues or have questions, feel free to open an issue on GitHub.
## Acknowledgements
Special thanks to the developers at Rev.io for creating the Odin API and to the engineers who provided invaluable feedback and feature suggestions.
Raw data
{
"_id": null,
"home_page": null,
"name": "odins-spear",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "broadworks, odin, api, telephony, voip",
"author": null,
"author_email": "Jordan Prescott <jordan@minimalmind.io>",
"download_url": "https://files.pythonhosted.org/packages/a4/44/19982262b73ad9f612a65f074dd5cd1a8bca6dd82ab7beb655eb469c1615/odins_spear-2.0.1.tar.gz",
"platform": null,
"description": "# \u2694\ufe0f Odin's Spear\n\nOfficially adopted by [Fourteen IP Communications](https://fourteenip.com/) leading supplier of hosted telephony in the hospitality industry. \n\n\n[](https://pepy.tech/project/odins-spear)\n[](https://pepy.tech/project/odins-spear)\n[](https://pepy.tech/project/odins-spear)\n## Overview\n\nOdin's Spear is a Python library designed to streamline and enhance your experience with Odin's API by [Rev.io](https://www.rev.io/blog/solutions/rev-io-odin-api). If you've worked with BroadWorks for years and struggled with its outdated interface and limitations, Odin's API feels like a breath of fresh air\u2014offering a modern user interface, automation, and comprehensive API access.\n\nWith Odin's Spear, managing users, hunt groups, call centers, and other telecom operations becomes significantly easier. This library encapsulates Odin's API functionality, making it accessible, efficient, and user-friendly.\n\n## Features\n\n- **Bulk User Management:** Create and manage thousands of users, hunt groups, and call centers in minutes.\n- **Error Handling:** Automatically manage authentication, request design, and error handling.\n- **Advanced Tools:** Features like call flow visualization, group audit reports, and bulk management of telecom entities.\n- **Alias Assignment Locator:** The first feature release addresses a long-standing issue by allowing you to easily locate where an alias is assigned within BroadWorks\u2014saving you time and frustration.\n\n## Why Odin's Spear?\n\nWorking with BroadWorks for over five years was a challenge, with its 90s-style UI and rigid functionality. When Rev.io introduced Odin, with its modern interface and API, it revolutionized how telecom management could be done. However, even with these advancements, some tasks remained cumbersome, like locating alias assignments. \n\nOdin's Spear is the solution. It simplifies your workflow by automating repetitive tasks, handling errors, and making API interactions as smooth as possible. Whether you're managing 10 users or 10,000, Odin's Spear has you covered.\n\n## \ud83d\ude80 Getting Started\n\n### Prerequisites\n\n- Python 3.12+\n- An Odin account\n\n### Installation\n\nInstall Odin's Spear using pip:\n\n```bash\npip install odins-spear\n```\n\n### Basic Usage\n\nHere's a simple example to get you started:\n\n```python\nfrom odins_spear import API, Scripter, Reporter\n\n# Initialize the API with your credentials\nmy_api = API(base_url=\"https://base_url/api/vx\", username=\"john.smith\", password=\"Your Password\")\nmy_api.authenticate()\n\nmy_assistant = Scripter(my_api)\n# Locate an alias assignment\nalias_info = my_assistant.find_alias('ServiceProviderID', 'GroupID', alias=0)\n\nmy_assitant = Reporter(my_api)\n# Generate call flow visual\nmy_assistant.call_flow(\n 'serviceProviderId',\n 'groupId',\n '3001',\n 'extension',\n 'auto_attendant'\n)\n```\n\nFor more detailed usage and examples, check out our [Documentation](#-documentation).\n\n## \ud83d\udcd6 Documentation\n\nWe provide extensive documentation to help you get started quickly and take full advantage of Odin's Spear's capabilities:\n\n- [Odin's Spear Documentation](https://docs.jordan-prescott.com/odins_spear)\n\n## Contributing\n\nWe welcome contributions! If you'd like to contribute, please fork the project, make your changes then submit a pull request. \nFor issues to work on please see our [project](https://github.com/users/Jordan-Prescott/projects/2).\n\n## License\n\nThis project is licensed under the MIT License\u2014see the [LICENSE.md](LICENSE) file for details.\n\n## Support\n\nIf you encounter any issues or have questions, feel free to open an issue on GitHub.\n\n## Acknowledgements\n\nSpecial thanks to the developers at Rev.io for creating the Odin API and to the engineers who provided invaluable feedback and feature suggestions.\n\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Jordan Prescott 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. ",
"summary": "Python package for Odin's API to build and manage Broadworks installations.",
"version": "2.0.1",
"project_urls": null,
"split_keywords": [
"broadworks",
" odin",
" api",
" telephony",
" voip"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2f046115a577530e8bbf0de16bbbd89ca45382e974d1938dd2a95692228edccd",
"md5": "e49e8119dddb9b70f03998ffa897f4b0",
"sha256": "a92d96d7f3844696890a4364797ba8a4aae7d5da1d0515eda83f2350e52d31a4"
},
"downloads": -1,
"filename": "odins_spear-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e49e8119dddb9b70f03998ffa897f4b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 114274,
"upload_time": "2025-01-24T13:09:09",
"upload_time_iso_8601": "2025-01-24T13:09:09.919867Z",
"url": "https://files.pythonhosted.org/packages/2f/04/6115a577530e8bbf0de16bbbd89ca45382e974d1938dd2a95692228edccd/odins_spear-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a44419982262b73ad9f612a65f074dd5cd1a8bca6dd82ab7beb655eb469c1615",
"md5": "a863715b94ce1fe5c1a3b5690ff89e13",
"sha256": "f0071c6f425550f85d6bae971a8915257bed7a1e4dd6aa8bdbbb697686e3ed55"
},
"downloads": -1,
"filename": "odins_spear-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a863715b94ce1fe5c1a3b5690ff89e13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 888328,
"upload_time": "2025-01-24T13:09:11",
"upload_time_iso_8601": "2025-01-24T13:09:11.814099Z",
"url": "https://files.pythonhosted.org/packages/a4/44/19982262b73ad9f612a65f074dd5cd1a8bca6dd82ab7beb655eb469c1615/odins_spear-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 13:09:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "odins-spear"
}
