Unicon Plugins
==============
.. note::
this is the plugins component of Unicon. The usage of this package requires
``unicon`` main package.
Unicon is a package aiming to provide a unified connection experience to network
devices through typical command-line management interface. By wrapping the
underlying session (eg, telnet, ssh), Unicon provides:
- direct and proxied connections through any common CLI interface (telnet, ssh, serial etc)
- power of expect-like programming without having to deal with low-level logic
- multi-vendor support through an agnostic API interface
- seamless handling of CLI modes (eg, enable, configure, admin-configure mode)
- rejected commands, command error detections
- value-add statful services (specific to the platform)
and is extensible: platform supports and services are implemented via
open-source plugins.
Unicon is the standard, go-to CLI connection implementation for `Cisco pyATS`_
framework.
.. _Cisco pyATS: https://developer.cisco.com/site/pyats/
This package was initially developed internally in Cisco, and is now
release to the general public starting late 2017 through `Cisco DevNet`_.
https://developer.cisco.com/pyats/
.. _Cisco DevNet: https://developer.cisco.com/
Requirements
------------
- Linux/macOS/WSL
- Python 3.4+
Quick Start
-----------
.. code-block:: bash
bash$ pip install unicon
For more information on setting up your Python development environment,
such as creating virtual environment and installing ``pip`` on your system,
please refer to `Virtual Environment and Packages`_ in Python tutorials.
.. _Virtual Environment and Packages: https://docs.python.org/3/tutorial/venv.html
Examples
--------
See example of a Unicon connection usage with Cisco IOS devices at:
https://github.com/CiscoDevNet/pyats-ios-sample
In addition, there is a sample plugin package you can follow to develop Unicon
plugins for new platforms on top of Unicon:
https://github.com/CiscoDevNet/pyats-plugin-examples/tree/master/unicon_plugin_example
Support & Community
-------------------
See https://developer.cisco.com/docs/pyats/#!license-support page for details.
Raw data
{
"_id": null,
"home_page": "https://developer.cisco.com/pyats",
"name": "unicon.plugins",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "unicon connection pyats cisco",
"author": "Cisco Systems Inc.",
"author_email": "pyats-support-ext@cisco.com",
"download_url": null,
"platform": null,
"description": "Unicon Plugins\n==============\n\n.. note::\n\n this is the plugins component of Unicon. The usage of this package requires\n ``unicon`` main package.\n\nUnicon is a package aiming to provide a unified connection experience to network\ndevices through typical command-line management interface. By wrapping the \nunderlying session (eg, telnet, ssh), Unicon provides:\n\n- direct and proxied connections through any common CLI interface (telnet, ssh, serial etc)\n- power of expect-like programming without having to deal with low-level logic\n- multi-vendor support through an agnostic API interface\n- seamless handling of CLI modes (eg, enable, configure, admin-configure mode)\n- rejected commands, command error detections\n- value-add statful services (specific to the platform)\n\nand is extensible: platform supports and services are implemented via \nopen-source plugins.\n\nUnicon is the standard, go-to CLI connection implementation for `Cisco pyATS`_\nframework.\n\n.. _Cisco pyATS: https://developer.cisco.com/site/pyats/\n\nThis package was initially developed internally in Cisco, and is now \nrelease to the general public starting late 2017 through `Cisco DevNet`_. \n\n https://developer.cisco.com/pyats/\n \n.. _Cisco DevNet: https://developer.cisco.com/\n\n\nRequirements\n------------\n\n- Linux/macOS/WSL\n- Python 3.4+\n\nQuick Start\n-----------\n\n.. code-block:: bash\n\n bash$ pip install unicon\n\n\nFor more information on setting up your Python development environment,\nsuch as creating virtual environment and installing ``pip`` on your system, \nplease refer to `Virtual Environment and Packages`_ in Python tutorials.\n\n.. _Virtual Environment and Packages: https://docs.python.org/3/tutorial/venv.html\n\nExamples\n--------\n\nSee example of a Unicon connection usage with Cisco IOS devices at:\n\n https://github.com/CiscoDevNet/pyats-ios-sample\n\nIn addition, there is a sample plugin package you can follow to develop Unicon\nplugins for new platforms on top of Unicon:\n\n https://github.com/CiscoDevNet/pyats-plugin-examples/tree/master/unicon_plugin_example\n\nSupport & Community\n-------------------\n\nSee https://developer.cisco.com/docs/pyats/#!license-support page for details.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Unicon Connection Library Plugins",
"version": "24.3",
"project_urls": {
"Homepage": "https://developer.cisco.com/pyats"
},
"split_keywords": [
"unicon",
"connection",
"pyats",
"cisco"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6e923d1a0999936e4b723486172784224ed04a5f5935f75f966ae061cf4c1e8",
"md5": "11eb6349eddcc007a72d3397ec46cb33",
"sha256": "87359235927fe28532e02c7c05516122efb3a10c0c27f8c3849a0903f09a21e4"
},
"downloads": -1,
"filename": "unicon.plugins-24.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11eb6349eddcc007a72d3397ec46cb33",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 841632,
"upload_time": "2024-03-26T18:40:00",
"upload_time_iso_8601": "2024-03-26T18:40:00.220951Z",
"url": "https://files.pythonhosted.org/packages/c6/e9/23d1a0999936e4b723486172784224ed04a5f5935f75f966ae061cf4c1e8/unicon.plugins-24.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 18:40:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "unicon.plugins"
}
JSON