# omnivista_py - An API Client for the Alcatel-Lucent OmniVista 2500
> a Python library that simplifies interaction with the OmniVista API.
[](https://github.com/phillipyosief/omnivista_py/actions/workflows/python-package.yml)
[](https://github.com/phillipyosief/omnivista_py/actions/workflows/python_publish.yml)
omnivista_py allows easy management of network devices, and querying of performance data. With integrated error handling and optional logging
## Installation
Using [PyPi](https://pypi.org/project/omnivista-py/)
```sh
pip install omnivista_py
```
## Usage example
With omnivista_py, it has never been easier to search for a device and retrieve information about it.
Here is an example of how to initialize the client, search for 3 devices using three different attributes, and then print out their software version, configured IP interfaces, and the current directory they are running in.
```python
from omnivista_py import OVClient, Device
client = OVClient(
url="https://omnivista.com",
username="your_username",
password="your_password"
)
client.login
device1 = client.Device(client, ip_address="192.168.1.1")
device2 = client.Device(client, hostname="myalcateldevice")
device3 = client.Device(client, mac_address="3a:5f:1c:7e:2b:9d")
devices = [device1, device2, device3]
for device in devices:
print(device.get_software_version())
print(device.get_ip_interfaces())
print(device.get_running_directory())
```
## Future Plans
There are several features and improvements planned for future releases of omnivita_py.
Which you can find all under [Projects](https://github.com/phillipyosief/omnivista_py/projects)
## Meta
Phillip Jerome Yosief
Distributed under the MIT license. See [``LICENSE``](LICENSE) for more information.
[github.com/phillipyosief/](https://github.com/phillipyosief/)
## Contributing
1. Fork it (<https://github.com/phillipyosief/omnivista_py/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
Raw data
{
"_id": null,
"home_page": "https://github.com/phillipyosief/omnivista_py",
"name": "omnivista-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "OmniVista 2500, Alcatel API, Alcatel Python, Alcatel Lucent, Alcatel, OmniVista, API, network management, device management, performance data, automation, network monitoring, Python",
"author": "Phillip Jerome Yosief",
"author_email": "Phillip Jerome Yosief <phillip.yosief@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/37/33/05ce995d81f30e48241bd186c72bbb50f680546bab519785003ecbf7e9f9/omnivista_py-0.3.8.tar.gz",
"platform": null,
"description": "# omnivista_py - An API Client for the Alcatel-Lucent OmniVista 2500\n> a Python library that simplifies interaction with the OmniVista API.\n\n\n\n\n[](https://github.com/phillipyosief/omnivista_py/actions/workflows/python-package.yml)\n[](https://github.com/phillipyosief/omnivista_py/actions/workflows/python_publish.yml)\n\nomnivista_py allows easy management of network devices, and querying of performance data. With integrated error handling and optional logging\n\n## Installation\n\nUsing [PyPi](https://pypi.org/project/omnivista-py/)\n```sh\npip install omnivista_py\n```\n\n## Usage example\n\nWith omnivista_py, it has never been easier to search for a device and retrieve information about it.\n\nHere is an example of how to initialize the client, search for 3 devices using three different attributes, and then print out their software version, configured IP interfaces, and the current directory they are running in.\n```python\nfrom omnivista_py import OVClient, Device\n\nclient = OVClient(\n url=\"https://omnivista.com\",\n username=\"your_username\",\n password=\"your_password\"\n)\nclient.login\n\ndevice1 = client.Device(client, ip_address=\"192.168.1.1\")\ndevice2 = client.Device(client, hostname=\"myalcateldevice\")\ndevice3 = client.Device(client, mac_address=\"3a:5f:1c:7e:2b:9d\")\n\ndevices = [device1, device2, device3]\n\nfor device in devices:\n print(device.get_software_version())\n print(device.get_ip_interfaces())\n print(device.get_running_directory())\n```\n\n## Future Plans\nThere are several features and improvements planned for future releases of omnivita_py.\nWhich you can find all under [Projects](https://github.com/phillipyosief/omnivista_py/projects)\n\n\n## Meta\n\nPhillip Jerome Yosief\n\nDistributed under the MIT license. See [``LICENSE``](LICENSE) for more information.\n\n[github.com/phillipyosief/](https://github.com/phillipyosief/)\n\n## Contributing\n\n1. Fork it (<https://github.com/phillipyosief/omnivista_py/fork>)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python library that simplifies interaction with the OmniVista API, enabling easy authentication, device management, and performance data querying.",
"version": "0.3.8",
"project_urls": {
"Homepage": "https://github.com/phillipyosief/omnivista_py",
"Issues": "https://github.com/phillipyosief/omnivista_py/issues"
},
"split_keywords": [
"omnivista 2500",
" alcatel api",
" alcatel python",
" alcatel lucent",
" alcatel",
" omnivista",
" api",
" network management",
" device management",
" performance data",
" automation",
" network monitoring",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28eb3f9216bd3715e7492ebac9d1f0d2716be00520c5762dedf0fcff285f6bdc",
"md5": "9fb8aeeeb087ae0f30007a54ee30bf30",
"sha256": "1da4b34ca6b3180e932b296135b1ca81a2528a269e1928f03653908837bf02f3"
},
"downloads": -1,
"filename": "omnivista_py-0.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9fb8aeeeb087ae0f30007a54ee30bf30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6360,
"upload_time": "2024-11-03T16:36:28",
"upload_time_iso_8601": "2024-11-03T16:36:28.455401Z",
"url": "https://files.pythonhosted.org/packages/28/eb/3f9216bd3715e7492ebac9d1f0d2716be00520c5762dedf0fcff285f6bdc/omnivista_py-0.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "373305ce995d81f30e48241bd186c72bbb50f680546bab519785003ecbf7e9f9",
"md5": "c400d82c95fc433898990d316664fbcd",
"sha256": "6c557150aed6780e2f67f3cc4080e74107041bf19411348cebf1d88c6117fb2d"
},
"downloads": -1,
"filename": "omnivista_py-0.3.8.tar.gz",
"has_sig": false,
"md5_digest": "c400d82c95fc433898990d316664fbcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5824,
"upload_time": "2024-11-03T16:36:30",
"upload_time_iso_8601": "2024-11-03T16:36:30.050797Z",
"url": "https://files.pythonhosted.org/packages/37/33/05ce995d81f30e48241bd186c72bbb50f680546bab519785003ecbf7e9f9/omnivista_py-0.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 16:36:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phillipyosief",
"github_project": "omnivista_py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "omnivista-py"
}
JSON
