Metadata-Version: 2.4
Name: unicon
Version: 26.2
Summary: Unicon Connection Library
Home-page: https://developer.cisco.com/pyats/
Author: Cisco Systems Inc.
Author-email: pyats-support-ext@cisco.com
License: Apache 2.0
Keywords: unicon connection pyats cisco
Classifier: Development Status :: 6 - Mature
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Requires-Dist: pyyaml
Requires-Dist: dill
Requires-Dist: unicon.plugins<26.3.0,>=26.2.0
Provides-Extra: robot
Requires-Dist: robotframework; extra == "robot"
Provides-Extra: pyats
Requires-Dist: pyats; extra == "pyats"
Provides-Extra: dev
Requires-Dist: coverage; extra == "dev"
Requires-Dist: restview; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: sphinxcontrib-napoleon; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

Unicon - Universal Connection Library
=====================================

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.
