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.
Raw data
{
"_id": null,
"home_page": "https://developer.cisco.com/pyats/",
"name": "unicon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"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 - Universal Connection Library\n=====================================\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",
"version": "25.6",
"project_urls": {
"Homepage": "https://developer.cisco.com/pyats/"
},
"split_keywords": [
"unicon",
"connection",
"pyats",
"cisco"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c475a9bdabf6504b563426d8c98a8918ea3a026a32a8dbcf8f1eebc6d58946d3",
"md5": "818b6b6a41e1943e23ebdf1bed711944",
"sha256": "142139b5f8980379426287a3015fcf8f774296fec0c7d5fc5d7a1607c32068e1"
},
"downloads": -1,
"filename": "unicon-25.6-cp310-cp310-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "818b6b6a41e1943e23ebdf1bed711944",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 4787326,
"upload_time": "2025-07-11T14:35:47",
"upload_time_iso_8601": "2025-07-11T14:35:47.209561Z",
"url": "https://files.pythonhosted.org/packages/c4/75/a9bdabf6504b563426d8c98a8918ea3a026a32a8dbcf8f1eebc6d58946d3/unicon-25.6-cp310-cp310-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "86d1de1f110cd01ae5eacc1116b1f1011c947d9654a772a4a8b77c295e156bd6",
"md5": "817ac76af4acad180b2661471f362e64",
"sha256": "d24d6d03c4ca87a7c5374f79d63ba148de4a7f9a6bf159668074b1047e0aae99"
},
"downloads": -1,
"filename": "unicon-25.6-cp310-cp310-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "817ac76af4acad180b2661471f362e64",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 13790708,
"upload_time": "2025-07-11T14:35:53",
"upload_time_iso_8601": "2025-07-11T14:35:53.002653Z",
"url": "https://files.pythonhosted.org/packages/86/d1/de1f110cd01ae5eacc1116b1f1011c947d9654a772a4a8b77c295e156bd6/unicon-25.6-cp310-cp310-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d9fbe25b130eb85fdf3f351e9e01169c671952162d18ac758e29f7e0ea3cd824",
"md5": "0631fb7343f1b63d3cdc4fb9514aba82",
"sha256": "b3bd6e3a3c5681dede73ea7b1dc4729a7a37c201e86c513117d2b7128afbeae1"
},
"downloads": -1,
"filename": "unicon-25.6-cp311-cp311-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "0631fb7343f1b63d3cdc4fb9514aba82",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 5428608,
"upload_time": "2025-07-11T14:35:56",
"upload_time_iso_8601": "2025-07-11T14:35:56.643024Z",
"url": "https://files.pythonhosted.org/packages/d9/fb/e25b130eb85fdf3f351e9e01169c671952162d18ac758e29f7e0ea3cd824/unicon-25.6-cp311-cp311-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1361e93be712c5bf21fb7d13ec92b462a0fcc831fa8d9a2eb00ccb74fbc2aa93",
"md5": "2bc28fed7a38161906bdf7fc09dbebd8",
"sha256": "30d234604bd2e6533d9a71a930d643ac128f28a0a7739c63c15481085e734d67"
},
"downloads": -1,
"filename": "unicon-25.6-cp311-cp311-manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "2bc28fed7a38161906bdf7fc09dbebd8",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 16160567,
"upload_time": "2025-07-11T14:36:02",
"upload_time_iso_8601": "2025-07-11T14:36:02.737522Z",
"url": "https://files.pythonhosted.org/packages/13/61/e93be712c5bf21fb7d13ec92b462a0fcc831fa8d9a2eb00ccb74fbc2aa93/unicon-25.6-cp311-cp311-manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "009eaf4b5ef9089c7c4358d2f4a017e92eb8e9bbd721e3c6e77879fcb28aee6b",
"md5": "e0906fc3926e70ada22d8b6a417ac321",
"sha256": "a910bf9a20b02097b653e10d32a5f32dd8ea9e5d68b9bfec89c26364a32d17a0"
},
"downloads": -1,
"filename": "unicon-25.6-cp311-cp311-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "e0906fc3926e70ada22d8b6a417ac321",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 14387333,
"upload_time": "2025-07-11T14:36:08",
"upload_time_iso_8601": "2025-07-11T14:36:08.807943Z",
"url": "https://files.pythonhosted.org/packages/00/9e/af4b5ef9089c7c4358d2f4a017e92eb8e9bbd721e3c6e77879fcb28aee6b/unicon-25.6-cp311-cp311-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dc58094aec8c4f5e6c9586342312ade633a74814056de0071a85183b15c8b969",
"md5": "e435f14e1f76b00590c33d4b4322a913",
"sha256": "82a06b17f64db29eedda4c9e03645b8f54aab4a5e0f2362d44affb70f6e85487"
},
"downloads": -1,
"filename": "unicon-25.6-cp312-cp312-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "e435f14e1f76b00590c33d4b4322a913",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.8",
"size": 5388989,
"upload_time": "2025-07-11T14:36:12",
"upload_time_iso_8601": "2025-07-11T14:36:12.509300Z",
"url": "https://files.pythonhosted.org/packages/dc/58/094aec8c4f5e6c9586342312ade633a74814056de0071a85183b15c8b969/unicon-25.6-cp312-cp312-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8b608d2196b70de151d40358633a509fbd5aa1c7ea53c6038eb25cdd3bfc3afa",
"md5": "974878e8e34b6337f84558e278511c3b",
"sha256": "1054b8af0ef81259a32e6a689472917874ea7480cae5a6ab27b5fa6fabc9f280"
},
"downloads": -1,
"filename": "unicon-25.6-cp312-cp312-manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "974878e8e34b6337f84558e278511c3b",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.8",
"size": 16038546,
"upload_time": "2025-07-11T14:36:19",
"upload_time_iso_8601": "2025-07-11T14:36:19.086706Z",
"url": "https://files.pythonhosted.org/packages/8b/60/8d2196b70de151d40358633a509fbd5aa1c7ea53c6038eb25cdd3bfc3afa/unicon-25.6-cp312-cp312-manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f3a5b4b09011fee2baec79403c0a693d5a7d4bedf2307530a2d48544976eef4a",
"md5": "9f79cce52538be00e3d41d7cc1b3be92",
"sha256": "10d671cd587e039a52126c673b51b53e64bc67704bd812c7432c2e913665aa6e"
},
"downloads": -1,
"filename": "unicon-25.6-cp312-cp312-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "9f79cce52538be00e3d41d7cc1b3be92",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": ">=3.8",
"size": 14964999,
"upload_time": "2025-07-11T14:36:28",
"upload_time_iso_8601": "2025-07-11T14:36:28.530371Z",
"url": "https://files.pythonhosted.org/packages/f3/a5/b4b09011fee2baec79403c0a693d5a7d4bedf2307530a2d48544976eef4a/unicon-25.6-cp312-cp312-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7005e7f380a3ca3d0feddbaee6bef102104df1fa2e9586ce629447abb0101b53",
"md5": "ca1c2b3a41c2fa9ea9d7904cc904e25f",
"sha256": "4613bcd894461fa4ae0a56ba16203c334e1eddfb9dfbc62293d7e4723c2d1360"
},
"downloads": -1,
"filename": "unicon-25.6-cp313-cp313-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "ca1c2b3a41c2fa9ea9d7904cc904e25f",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.8",
"size": 5296140,
"upload_time": "2025-07-11T14:36:31",
"upload_time_iso_8601": "2025-07-11T14:36:31.947730Z",
"url": "https://files.pythonhosted.org/packages/70/05/e7f380a3ca3d0feddbaee6bef102104df1fa2e9586ce629447abb0101b53/unicon-25.6-cp313-cp313-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "30a6e07b1ced5c7b88d0457f88fea4ccbcf99c27bbbb3cddffce311068e71dbc",
"md5": "352ba55ea2b32765120047f25c73579b",
"sha256": "f8a373dc13a93e52719ca363016a1b2aac3f30305eca05e4c692ee383e360565"
},
"downloads": -1,
"filename": "unicon-25.6-cp313-cp313-manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "352ba55ea2b32765120047f25c73579b",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.8",
"size": 15914307,
"upload_time": "2025-07-11T14:36:38",
"upload_time_iso_8601": "2025-07-11T14:36:38.294844Z",
"url": "https://files.pythonhosted.org/packages/30/a6/e07b1ced5c7b88d0457f88fea4ccbcf99c27bbbb3cddffce311068e71dbc/unicon-25.6-cp313-cp313-manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ea14cca02ddecf909e3e11043a58070e4896d895ddeed35a8fa4b1e301cbc2af",
"md5": "f6ba35f5d3d56d392110b75ed2820ef8",
"sha256": "2006a15d448d1459857973ace7561dd9b712a16cd722e6abc91a1360262f6e3c"
},
"downloads": -1,
"filename": "unicon-25.6-cp313-cp313-manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "f6ba35f5d3d56d392110b75ed2820ef8",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.8",
"size": 13853010,
"upload_time": "2025-07-11T14:36:44",
"upload_time_iso_8601": "2025-07-11T14:36:44.018094Z",
"url": "https://files.pythonhosted.org/packages/ea/14/cca02ddecf909e3e11043a58070e4896d895ddeed35a8fa4b1e301cbc2af/unicon-25.6-cp313-cp313-manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "062d05b06bb63d2f04d6285c0e817dea964ef5765bc922cfbb6d2241127c4bb2",
"md5": "ffb431bf4d77557ae4c74ba839fe3eae",
"sha256": "e5c22d92bbd0c45bb4deefbd3d65d737f8bf47be5915b2e75adf95167150a1bb"
},
"downloads": -1,
"filename": "unicon-25.6-cp39-cp39-macosx_11_0_universal2.whl",
"has_sig": false,
"md5_digest": "ffb431bf4d77557ae4c74ba839fe3eae",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 4806057,
"upload_time": "2025-07-11T14:36:47",
"upload_time_iso_8601": "2025-07-11T14:36:47.460985Z",
"url": "https://files.pythonhosted.org/packages/06/2d/05b06bb63d2f04d6285c0e817dea964ef5765bc922cfbb6d2241127c4bb2/unicon-25.6-cp39-cp39-macosx_11_0_universal2.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "403e7fd5b799e87039930af44c612d60e261fcd439fe68b75e90f1062c4bcaf0",
"md5": "b833fdc8d03c57d0696676903b94c460",
"sha256": "28b7acf086bfe42a1ffa2b163b9b787e2fe8cefc79f134d01a8be4b111bc76ce"
},
"downloads": -1,
"filename": "unicon-25.6-cp39-cp39-manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "b833fdc8d03c57d0696676903b94c460",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 14444270,
"upload_time": "2025-07-11T14:36:53",
"upload_time_iso_8601": "2025-07-11T14:36:53.253134Z",
"url": "https://files.pythonhosted.org/packages/40/3e/7fd5b799e87039930af44c612d60e261fcd439fe68b75e90f1062c4bcaf0/unicon-25.6-cp39-cp39-manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8370759c5a5dc190b2fbdd93b652ce7f380856550ce91505301d1aec41b12261",
"md5": "c8e245cfb7ae8cd222eab61caa5e5138",
"sha256": "05d68d50c9412f29ae5ea5b1d5211b8684ff97e126e9bb04867562d87346b2c2"
},
"downloads": -1,
"filename": "unicon-25.6-cp39-cp39-musllinux_1_2_x86_64.whl",
"has_sig": false,
"md5_digest": "c8e245cfb7ae8cd222eab61caa5e5138",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.8",
"size": 3155637,
"upload_time": "2025-07-11T14:36:55",
"upload_time_iso_8601": "2025-07-11T14:36:55.862682Z",
"url": "https://files.pythonhosted.org/packages/83/70/759c5a5dc190b2fbdd93b652ce7f380856550ce91505301d1aec41b12261/unicon-25.6-cp39-cp39-musllinux_1_2_x86_64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 14:35:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "unicon"
}
JSON