{ "info": { "author": "Cyril Desjouy", "author_email": "ipselium@free.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Debuggers" ], "description": "- - -\n\n# cpyvke\nCurses PYthon Variable and Kernel Explorer\n\n![A Basic Client](https://github.com/ipselium/cpyvke/blob/master/docs/pydev.png)\n\n\ncpyvke is a variable explorer and a kernel manager written in Python 3 ncurses\nfor iPython kernels (Python 2.x or 3.x).\ncpyvke supports inspection of numpy ndarray among others types, and provides a set of\ntools to visualize and plot data.\n\nBe aware that cpyvke is **still in development** : A lot of bugs are definitely there !\n\nNote that this version only works with Python 3.x. The Python 2.7 version is no\nlonger maintened !\n\n- - -\n\n## cpyvke : the Curses interface\n\n*Variable explorer and kernel manager.*\n\n* Explore variables in IPython kernels\n* Manage IPython kernels\n\n- - -\n\n## kd5 : the daemon to communicate with IPython kernels\n\n*Communication with ipython kernels.*\n\n* Stream variable list each time a change occurs in the kernel\n* Listen to request from the client\n\n- - -\n\n## Requirement\n\n* 256 colors terminal is preferred, but cpyvke also works with 8 colors terminals.\n* python3-tk : install it with your package manager\n* Tested with **python 3.5, 3.6 and 3.7**\n\n- - -\n\n## Dependencies\n\n* Ipython >= 5.1 (tested with 5.1.0 -- 7.2.0 -- 7.8.0)\n* ipykernel (tested with 4.6.1 -- 5.0.1 -- 5.1.3)\n* jupyter_client >= 4.4 (tested with 4.4.0 -- 5.2.4 -- 5.3.4)\n* psutil (tested with 3.4.2)\n* numpy (tested with 1.13.0)\n* matplotlib (tested with 1.5.1)\n\n\n\n- - -\n\n## Installation\n\n`git clone https://github.com/ipselium/cpyvke.git`\n`python3 setup.py install`\n\n### or\n\npip install cpyvke\n\n- - -\n\n## Quick Start\n\nTo start working, just launch `cpyvke` in a console. It will create a new kernel, start the daemon and launch the client :\n\n`cpyvke`\n\nYou can also launch `cpyvke-launch-ipython` to open the current kernel :\n\n`cpyvke-launch-ipython`\n\nYou can now work in this Ipython console and cpyvke will display all changes in the associated kernel :\n\n`In [1] : run my_program.py`\n\n\n## Tips\n\nYou can also use : https://github.com/ipselium/vim-cpyvke\n\n**vim-cpyvke** provides tools to evaluate blocks of code or full scripts\ndirectly from vim. The duo **cpyvke/vim-cpyvke** paired with a vim plugin such\nas **python-mode** (www.github.com/klen/python-mode) can provide a complete\ndevelopment environment for Python in console.\n\n- - -\n\n## Manuals\n\n### kd5 : The Daemon\n\n*Usage: kd5 {start|stop|restart|list} [INTEGER]*\n\n* start : start daemon. If no [INTEGER] is provided, a new ipython kernel is created. [INTEGER] is the id of the connection file.\n* stop : stop daemon\n* restart : restart daemon\n* list : list available ipython kernels\n\n### cpyvke : The client\n\n*Usage: cpyvke [-h] [-L] [-D] [integer]*\n\n* positional arguments:\n\t* [integer] : Start up with existing kernel. INTEGER is the id of the connection file.\n\n* optional arguments:\n\t* [-h], [--help] : show this help message and exit\n\t* [-D], [--debug] : Debug mode\n\t* [-L], [--list] : List all kernels\n\n* bindings:\n\t* **h** : help\n\t* **ENTER** : Validate/Item menu\n\t* **q|ESC** : Previous menu/quit'\n\t* **s** : sort by name/type\n\t* **l** : limit display to all variable matching the given keyword\n\t* **u** : undo limit\n\t* **k** : kernel manager\n\t* **/** : Search for variable\n\t* **q** : previous menu -- quit\n\t* **r** : Refresh explorer\n\t* **c-r** : Restart Daemon\n\t* **R** : Restart connection to daemon\n\t* **D** : Disconnect from daemon\n\t* **C** : Connect to daemon\n\t* **\u2193** : Next line\n\t* **\u2191** : Previous line\n\t* **\u2192|\u21a1** Next page\n\t* **\u2190|\u219f** Previous page\n\n### Setup workspace\n\n* You can directly launch `cpyvke`. It will create a new kernel, start the daemon and launch the client\n* cpyvke-launch-ipython automatically launch the current ipython console\n* You can also manually open an existing ipython instance like this :\n\t`ipython console --existing kernel-xxxxx.json`\nwhere xxxxx is the id of the kernel\n\n### Note\n\nIf you just want to test cpyvke without installing. In cpyvke/ directory :\n\n* launch kd5 first : `python3 -m cpyvke.kd5 start`\n* then launch cpyvke : `python3 -m cpyvke.cpyvke`\n* and launch ipython in another console : `python3 -m cpyvke.launch`\n\n- - -\n\n## Configuration\n\n![Configuration](https://github.com/ipselium/cpyvke/blob/master/docs/array.png)\n\nA configuration file *cpyvke.conf* is created in `$HOME/.cpyvke/` at first startup. Appearance of the client can be customize (colors, font).\n\n### Colors\n\nThe available colors are...\n\n* black\n* red\n* green\n* yellow\n* blue\n* magenta\n* cyan\n* white\n\n### Fonts\n\ncpyvke can also display powerline fonts. You can find them here :\nhttps://github.com/powerline/fonts.\n\nAdd the following section in `$HOME/.cpyvke/cpyvke.conf`:\n\n`[font]`\n\n`powerline-font = True`\n\n### Python kernel version\n\nThe cpyvke/kd5 duo handles python 2.x or 3.x kernel equally. To setup the Python kernel you'll want to use :\n\n`[kernel version]`\n\n`version = 3`\n\nThe `version` can be 2 or 3 for python 2.x kernel or 3.x kernel, respectively.\n\n\n- - -\n\n## Known Bugs\n\n*cpyvke* is still in developpement and may present unexpected behavior !\n\n- - -", "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/ipselium/cpyvke", "keywords": "", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "cpyvke", "package_url": "https://pypi.org/project/cpyvke/", "platform": "", "project_url": "https://pypi.org/project/cpyvke/", "project_urls": { "Homepage": "https://github.com/ipselium/cpyvke" }, "release_url": "https://pypi.org/project/cpyvke/1.2.10/", "requires_dist": null, "requires_python": "", "summary": "A Kernel and variable explorer in Curses", "version": "1.2.10", "yanked": false, "yanked_reason": null }, "last_serial": 8420308, "releases": { "1.2.10": [ { "comment_text": "", "digests": { "md5": "2019bb0f420982daca232222d15ec2d0", "sha256": "e2f6b519f7bfc0f8deb335c8f47082df3ecc03c97e96d839a2dcec9a774296e9" }, "downloads": -1, "filename": "cpyvke-1.2.10.tar.gz", "has_sig": false, "md5_digest": "2019bb0f420982daca232222d15ec2d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41163, "upload_time": "2020-10-15T16:39:16", "upload_time_iso_8601": "2020-10-15T16:39:16.148913Z", "url": "https://files.pythonhosted.org/packages/da/8e/a8cd82d132a6b028656ce7a8df1f410a9c39a49c3b103a5339adca6b50cf/cpyvke-1.2.10.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.4": [ { "comment_text": "", "digests": { "md5": "6e6add8df9a0a2904ddcb908811349b0", "sha256": "23806ba6f0fd9309aed3c00ed2c45e17145b8b6da558e2b7150a2a77413fd945" }, "downloads": -1, "filename": "cpyvke-1.2.4.tar.gz", "has_sig": false, "md5_digest": "6e6add8df9a0a2904ddcb908811349b0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38403, "upload_time": "2018-04-10T19:49:04", "upload_time_iso_8601": "2018-04-10T19:49:04.541593Z", "url": "https://files.pythonhosted.org/packages/f0/65/4d88562f873df6f5b5a6fcc7eedfac850c0001d7a97d1ba66d0ace87a864/cpyvke-1.2.4.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.5": [ { "comment_text": "", "digests": { "md5": "50dff233bfe0b7d6fcad36c7b4962682", "sha256": "677d994e022b4855c748c38a26ffaef29c7aed42cb42985ec00e3a0e2529365f" }, "downloads": -1, "filename": "cpyvke-1.2.5.tar.gz", "has_sig": false, "md5_digest": "50dff233bfe0b7d6fcad36c7b4962682", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39385, "upload_time": "2019-10-21T11:58:22", "upload_time_iso_8601": "2019-10-21T11:58:22.405992Z", "url": "https://files.pythonhosted.org/packages/9f/a4/85174da0e066ea0972a45ddb73d33aef4e98e56ea0c8b9c1334ea71216a5/cpyvke-1.2.5.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.6": [ { "comment_text": "", "digests": { "md5": "67c817be6e619e30eacc0a3803e39e58", "sha256": "b8930e1396d1302fdc0a65612a263ea6cf4ed5d5c65044edf0827255fa3d7724" }, "downloads": -1, "filename": "cpyvke-1.2.6.tar.gz", "has_sig": false, "md5_digest": "67c817be6e619e30eacc0a3803e39e58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39398, "upload_time": "2019-10-21T14:50:07", "upload_time_iso_8601": "2019-10-21T14:50:07.770780Z", "url": "https://files.pythonhosted.org/packages/a1/5a/8096e7c53711353d7209c4f430c315186428ca5a50a38cbb9c6abbd1051a/cpyvke-1.2.6.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.7": [ { "comment_text": "", "digests": { "md5": "26bb2ea33195ae236535114b5c9b18dc", "sha256": "2ed7836e5367d2584952b2c96a05ab227a3e501ca426ddcd77e7339bfeca29f3" }, "downloads": -1, "filename": "cpyvke-1.2.7.tar.gz", "has_sig": false, "md5_digest": "26bb2ea33195ae236535114b5c9b18dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39402, "upload_time": "2019-10-21T15:16:49", "upload_time_iso_8601": "2019-10-21T15:16:49.926778Z", "url": "https://files.pythonhosted.org/packages/ec/1c/0f694eb3354fe50c8a9cf8d2c8afb4a17f71ad905e3acc547e369925b236/cpyvke-1.2.7.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.8": [ { "comment_text": "", "digests": { "md5": "5c8559d8f29acd2f1cdf058ba602af84", "sha256": "4646305e3dbcba28aebfc62a3889363af1a75ec4aaf92b0ce112c0052a9e659e" }, "downloads": -1, "filename": "cpyvke-1.2.8.tar.gz", "has_sig": false, "md5_digest": "5c8559d8f29acd2f1cdf058ba602af84", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41039, "upload_time": "2020-10-15T15:31:39", "upload_time_iso_8601": "2020-10-15T15:31:39.677316Z", "url": "https://files.pythonhosted.org/packages/4c/f1/5089548aca4b6ec79b8d37d7e234b369dd291820453650357d96f7a743ae/cpyvke-1.2.8.tar.gz", "yanked": false, "yanked_reason": null } ], "1.2.9": [ { "comment_text": "", "digests": { "md5": "7cea44ff977a670be676f2595cd7c24f", "sha256": "717c01af90e2accd780571ca45fbe7ba484a323f0325a78e9ef47d8b4437b01f" }, "downloads": -1, "filename": "cpyvke-1.2.9.tar.gz", "has_sig": false, "md5_digest": "7cea44ff977a670be676f2595cd7c24f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41032, "upload_time": "2020-10-15T15:50:08", "upload_time_iso_8601": "2020-10-15T15:50:08.970254Z", "url": "https://files.pythonhosted.org/packages/0e/b8/7b57699886f31be62d6aecf22f87a71724194417b7aaa15b4dad179755b6/cpyvke-1.2.9.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2019bb0f420982daca232222d15ec2d0", "sha256": "e2f6b519f7bfc0f8deb335c8f47082df3ecc03c97e96d839a2dcec9a774296e9" }, "downloads": -1, "filename": "cpyvke-1.2.10.tar.gz", "has_sig": false, "md5_digest": "2019bb0f420982daca232222d15ec2d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41163, "upload_time": "2020-10-15T16:39:16", "upload_time_iso_8601": "2020-10-15T16:39:16.148913Z", "url": "https://files.pythonhosted.org/packages/da/8e/a8cd82d132a6b028656ce7a8df1f410a9c39a49c3b103a5339adca6b50cf/cpyvke-1.2.10.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }