{ "info": { "author": "Viktor Kertesz", "author_email": "vkertesz2@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "Intended Audience :: Telecommunications Industry", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: POSIX", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3" ], "description": "CLI colorizer\n=============\n\nThis project is to colorize output of command line interface for devices where CLI is not colored by default. Goal is to ease troubleshooting and make output more pretty.\n\n[![License](http://img.shields.io/badge/license-GPLv3-blue.svg)](https://www.gnu.org/copyleft/gpl.html)\n[![Cisco Devnet Published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/realvitya/clicol)\n\n![image](https://realvitya.files.wordpress.com/2017/02/shint1.png)\n\nINSTALL\n-------\n\n - You will need python 2.6+ and pexpect\n - telnet and/or ssh should be installed\n - I recommend installing [virtualenv](https://pypi.org/project/virtualenv) and install [clicol](https://pypi.org/project/clicol) into that virtual environment:\n * `pip install virtualenv`\n * `virtualenv \\~/mypython`\n * `source \\~/mypython/bin/activate`\n * `pip install clicol`\n * OR (after pulling git source)\n * `pip install clicol-xxxx.zip`\n\n - To get clicol source:\n * `git clone https://github.com/realvitya/clicol \\~/clicol`\n * `cd \\~/clicol`\n\n - Copy\n [clicol.cfg](https://github.com/realvitya/clicol/blob/master/doc/clicol.cfg) to your \\$HOME directory and modify to your needs\n\nUSAGE\n-----\n\nRun the script `clicol-telnet` or `clicol-ssh` and specify arguments as for the telnet/ssh.\n\nclicol can be run on Windows in [cygwin](https://www.cygwin.com). If you want to use [SecureCRT](https://www.vandyke.com/products/securecrt), you must enable sshd in [cygwin](https://www.cygwin.com) and connect to localhost. It is not necessary to be administrator on the desktop for this to work. You must bind to localhost and use port number \\>1024.\n\nBy default clicol will colorize with all colorsets and this behaviour can be tuned in config file. The config file can be saved in user directory and it will take preference over defaults.\n\nDefault break key is CTRL-\\\\\n\nAfter hitting the break key you have some options:\n\np - pausing coloring\n\nq - quit from session\n\nh - print help\n\nT - highlight regex (set regex in runtime to highligh something important)\n\nF1-F12 keys are shortcuts for various commands. Examples are in example config file or try help 'h' key. Shortcuts for SHIFT+F1-F8 are only working if your terminal supports this. For [SecureCRT](https://www.vandyke.com/products/securecrt) you may setup mapped keys for these to work. (for [Putty](https://www.chiark.greenend.org.uk/~sgtatham/putty/) I don't know yet how to implement this)\n\n*Note: If you installed into virtualenv then you must first activate it:*\n\n**source \\~/mypython/bin/activate**\n\nConsider using aliases. A basic template can be found in *doc* folder.\n\nYour terminal software should support ANSI colors. [Putty](https://www.chiark.greenend.org.uk/~sgtatham/putty/)/[SecureCRT](https://www.vandyke.com/products/securecrt) are tested. I am developing with default colorsets. If you are using other software, colors can differ somewhat.\n\nTESTING\n-------\n\nYou can list all supported matchers and see them in action. This is good to create a list of matcher and filter on those only. This way one can select the preferred matchers if finds all of them disturbing. Run the script `clicol-test {regex}`\n\nUse case examples:\n\nList all matcher:\n\n`clicol-test \".*\"`\n\nList only BGP matchers:\n\n`clicol-test \".*bgp.*\"`\n\nList only certain matchers:\n\n`clicol-test \".*ipv4|cisco_if_stats|juniper_if\"`\n\nThen the desired regex can be specified in the clicol.cfg in your \\$HOME and only these matchers will be used.\n\nOutput can be tested by running `clicol-file {filename}` script. This will colorize the textfile and dump it. Good for testing.\n\nCUSTOMIZING\n-----------\n\nYou can override or extend the colors and regexes so you can modify default behaviour and view. This can be done by creating the customized files in the format below. You may find examples in default ini files here\n\n`ls -l $VIRTUAL_ENV/lib/python2*/site-packages/clicol/ini`\n\n### Custom colors\n\n`$HOME/clicol_customcolors.ini`\n\nThis file is for overriding extending current colorset. Example:\n\n [colors]\n c_blue :\\033[94m\n\n### Custom colortable\n\n`$HOME/clicol_customct.ini`\n\nThis file is for overriding or extending keywords for colors. Example:\n\n [colortable]\n #add blinking to high alert color:\n highalert = %(c_blink)s%(c_u_lred)s\n\n### Custom colormap\n\n`$HOME/clicol_customcmap.ini`\n\nThis file is for overriding or extending rules for recoloring/matching.\nExample:\n\n #disable ipv6 coloring\n [common_ipv6]\n disabled=1\n\n #alter coloring for 'shutdown'\n [common_shut]\n #replacement=%(alert)s\\1%(default)s\n replacement=%(lowalert)s\\1%(default)s\n\nYou can test your changes: `clicol-test common_shut`\n\nLicense and Copyright\n---------------------\n\n[clicol](https://pypi.org/project/clicol) is licensed [GPLv3](http://www.gnu.org/licenses/gpl-3.0.html) Copyright Viktor Kertesz, 2017-2019\n\nAuthor\n------\n\n[clicol](https://pypi.org/project/clicol) was written by Viktor Kertesz\n(vkertesz2 [\\~at\\~] gmail [/dot] com).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/realvitya/clicol", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "clicol", "package_url": "https://pypi.org/project/clicol/", "platform": "", "project_url": "https://pypi.org/project/clicol/", "project_urls": { "Homepage": "https://github.com/realvitya/clicol" }, "release_url": "https://pypi.org/project/clicol/1.1.0.post3/", "requires_dist": null, "requires_python": "", "summary": "CLI colorizer", "version": "1.1.0.post3" }, "last_serial": 4720641, "releases": { "0.1.10": [ { "comment_text": "", "digests": { "md5": "a187aaf8670983b12ce4750141643e32", "sha256": "03719a12144ea962610d9e72a23834d68df3db988e74409f7ca820bc482b2e64" }, "downloads": -1, "filename": "clicol-0.1.10.tar.gz", "has_sig": false, "md5_digest": "a187aaf8670983b12ce4750141643e32", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27887, "upload_time": "2018-03-22T08:22:36", "url": "https://files.pythonhosted.org/packages/51/74/7ea5f5d4d2a55a9408e142e1fa0a1171358f002713a9ca13310acb11852a/clicol-0.1.10.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "4eabfbb0a43f446309a5429b5982dfd5", "sha256": "d513bdbad3fd628a33dc76d093191c0c83c6317fb83a37f6610095ab084a1ee5" }, "downloads": -1, "filename": "clicol-0.1.5.tar.gz", "has_sig": false, "md5_digest": "4eabfbb0a43f446309a5429b5982dfd5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27067, "upload_time": "2018-02-08T21:27:42", "url": "https://files.pythonhosted.org/packages/24/ef/b3e29f34162269d55ce2f2c54aaa9a11d51cb17b5a3fa1c67dc08192c8e6/clicol-0.1.5.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "161b42ed498db8592ae35122e3a050bd", "sha256": "682cbb3fd87b122802c1e1c07e841039f60c6fed46b58108b4819cd08bf103ec" }, "downloads": -1, "filename": "clicol-0.1.7.tar.gz", "has_sig": false, "md5_digest": "161b42ed498db8592ae35122e3a050bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26950, "upload_time": "2018-02-23T08:38:52", "url": "https://files.pythonhosted.org/packages/d9/1c/b447eb7be34f0b6b9d877974ea97fa94c5a29fdabfb7ea88da916c3a71f9/clicol-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "3cea431c45d927e2cdd837dc30b93d28", "sha256": "ded7ae3b15cdf00316e836c244a7c163cdd4bf29043c7c02365fc3d38909d813" }, "downloads": -1, "filename": "clicol-0.1.8.tar.gz", "has_sig": false, "md5_digest": "3cea431c45d927e2cdd837dc30b93d28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27005, "upload_time": "2018-02-23T13:38:34", "url": "https://files.pythonhosted.org/packages/b8/6f/3200f468323ce39c32d1e13c59e0aa2662ba0f40e289993e9b08918a5d82/clicol-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "3bb8b50ea84a757d894bc9de876f0cd6", "sha256": "698fe680580c269b9de7866a6c51b8f90e136413c69656098337b7001494d770" }, "downloads": -1, "filename": "clicol-0.1.9.tar.gz", "has_sig": false, "md5_digest": "3bb8b50ea84a757d894bc9de876f0cd6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27629, "upload_time": "2018-02-23T13:48:56", "url": "https://files.pythonhosted.org/packages/34/f9/2c651ca6d89bc0b9e8ce3cf32bcdcb81a67e16a730861285f62192290d69/clicol-0.1.9.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "30cd8fe7a8fd967e1221a053d371ef2b", "sha256": "ec7e72803c43e373ab087ccb1c73e95f2a86067cbaec5ed4cbaa7fa47724f554" }, "downloads": -1, "filename": "clicol-0.2.0.tar.gz", "has_sig": false, "md5_digest": "30cd8fe7a8fd967e1221a053d371ef2b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29598, "upload_time": "2018-04-29T11:21:29", "url": "https://files.pythonhosted.org/packages/ef/45/7dc88fc4b98689e9363dc0d2f665c15837866dd4e59d67a4aae9f09ccb08/clicol-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "f950db1b0856a128dde8e0bb2267ff45", "sha256": "5576a8b51d6ccfba4f6ad64ac2783c4f048d8b632e273c1bb2353c8e4048033d" }, "downloads": -1, "filename": "clicol-0.2.1.tar.gz", "has_sig": false, "md5_digest": "f950db1b0856a128dde8e0bb2267ff45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30770, "upload_time": "2018-05-09T15:37:31", "url": "https://files.pythonhosted.org/packages/74/1b/f7226c431feacd768336f5f00300fd01fd97ab60802f26b01247d7c08619/clicol-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "90a5f7c85e9359f684a79a6cbfc29499", "sha256": "895ae11dacdcf01eb7b695fa285015da6869186d7cc04ae2bc4aa97d5df35808" }, "downloads": -1, "filename": "clicol-0.2.2.tar.gz", "has_sig": false, "md5_digest": "90a5f7c85e9359f684a79a6cbfc29499", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31191, "upload_time": "2018-07-04T20:08:48", "url": "https://files.pythonhosted.org/packages/b9/55/0302c5b37beb4bf516ab1a1a89dff4222949138d54047933a674740d25bc/clicol-0.2.2.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "589a0828119dfe3fba0273abedb8b836", "sha256": "646cc52ae7a752a5ad43facb32d980495df96c55a6011d3627a9f4b3da51df07" }, "downloads": -1, "filename": "clicol-1.0.0.tar.gz", "has_sig": false, "md5_digest": "589a0828119dfe3fba0273abedb8b836", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32225, "upload_time": "2018-10-31T16:21:50", "url": "https://files.pythonhosted.org/packages/1a/a8/79ecb4b223d2d959a62202a7476428e8f2b46d9b186a690f9be62969c455/clicol-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "65db5cc893c97eac33989bc8ae27df4d", "sha256": "e353bb857a3fed97277c16cb201daed1d641cf8ef42008eec3bae3d28e3688a3" }, "downloads": -1, "filename": "clicol-1.0.1.tar.gz", "has_sig": false, "md5_digest": "65db5cc893c97eac33989bc8ae27df4d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33709, "upload_time": "2019-01-04T10:31:11", "url": "https://files.pythonhosted.org/packages/50/2b/b27de87beadf2c69865057d5d18282a84e4bc95152f7fd1816a5af68a7a5/clicol-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "6050426ef50b46c4afb6aca7f51f154f", "sha256": "0d42927bd222746d29d535d7c903a9a81dae5887f7bc08a0dc1e45ffa0405b1c" }, "downloads": -1, "filename": "clicol-1.1.0.tar.gz", "has_sig": false, "md5_digest": "6050426ef50b46c4afb6aca7f51f154f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34063, "upload_time": "2019-01-20T17:19:19", "url": "https://files.pythonhosted.org/packages/b4/3b/5f435287e6c8e53bb01054b07ffe92322236f2750e105750854b51504852/clicol-1.1.0.tar.gz" } ], "1.1.0.post2": [ { "comment_text": "", "digests": { "md5": "ea8d8059ac6d8ab543f50bc6632c073a", "sha256": "eda73c89c0f702c38306a978ce1586313b7b0a5acc1c955c446c7a0169e8162d" }, "downloads": -1, "filename": "clicol-1.1.0.post2.tar.gz", "has_sig": false, "md5_digest": "ea8d8059ac6d8ab543f50bc6632c073a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34127, "upload_time": "2019-01-20T17:32:34", "url": "https://files.pythonhosted.org/packages/0e/a5/bee7d6d940cc09093be1e76e1f940363b315959457a4dc1dd515f4644fa8/clicol-1.1.0.post2.tar.gz" } ], "1.1.0.post3": [ { "comment_text": "", "digests": { "md5": "9cec852dfacd4fded392b53360ee4355", "sha256": "572f3de9eb4fcbdbb42986ea619a1fb3caecbee6cbedf91db72f94df9aaa8a2c" }, "downloads": -1, "filename": "clicol-1.1.0.post3.tar.gz", "has_sig": false, "md5_digest": "9cec852dfacd4fded392b53360ee4355", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34153, "upload_time": "2019-01-21T07:53:15", "url": "https://files.pythonhosted.org/packages/dd/35/915401c1466f97531de2b848ad1fec14c40d929db3b2fc8f910c0201bc89/clicol-1.1.0.post3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9cec852dfacd4fded392b53360ee4355", "sha256": "572f3de9eb4fcbdbb42986ea619a1fb3caecbee6cbedf91db72f94df9aaa8a2c" }, "downloads": -1, "filename": "clicol-1.1.0.post3.tar.gz", "has_sig": false, "md5_digest": "9cec852dfacd4fded392b53360ee4355", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34153, "upload_time": "2019-01-21T07:53:15", "url": "https://files.pythonhosted.org/packages/dd/35/915401c1466f97531de2b848ad1fec14c40d929db3b2fc8f910c0201bc89/clicol-1.1.0.post3.tar.gz" } ] }