{"id":14964395,"url":"https://github.com/user202729/plover-debugging-console","last_synced_at":"2026-02-08T13:31:42.699Z","repository":{"id":57453579,"uuid":"386515910","full_name":"user202729/plover-debugging-console","owner":"user202729","description":"A IPython debugging console for Plover.","archived":false,"fork":false,"pushed_at":"2022-05-13T15:34:21.000Z","size":32,"stargazers_count":0,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T11:02:13.594Z","etag":null,"topics":["plover","plover-plugins"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/user202729.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-16T05:06:22.000Z","updated_at":"2021-12-06T12:34:14.000Z","dependencies_parsed_at":"2022-08-29T11:11:33.599Z","dependency_job_id":null,"html_url":"https://github.com/user202729/plover-debugging-console","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/user202729%2Fplover-debugging-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/user202729%2Fplover-debugging-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/user202729%2Fplover-debugging-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/user202729%2Fplover-debugging-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/user202729","download_url":"https://codeload.github.com/user202729/plover-debugging-console/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247865861,"owners_count":21009235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plover","plover-plugins"],"created_at":"2024-09-24T13:33:07.423Z","updated_at":"2026-02-08T13:31:42.670Z","avatar_url":"https://github.com/user202729.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# plover-debugging-console\nA IPython debugging console for Plover.\n\nSee also:\n\n* [`plover-run-py` plugin](https://github.com/user202729/plover-run-py) for\nexecuting a Python command with a stroke, or from the command-line.\n\n### Usage\n\n* Install the plugin.\n* Enable the extension plugin in Plover.\n* Run the command `plover-debugging-console-connect` (or `plover -s plover-debugging-console-connect`)\nin a terminal.\n\nThe global variable `engine` is given. Other objects can be accessed from `engine` as public\nor private members.\n\nAlternatively, `plover-debugging-console-connect qtconsole` can be used to launch a console-style application using Qt.\nSee documentation of `jupyter qtconsole` for more details.\n\nOr `plover-debugging-console-execute` can be used to execute a file non-interactively. See note below.\n\n### Known issues\n\nThose errors can be fixed by installing the latest version of `background_zmq_ipython` manually on GitHub. Refer to\nhttps://github.com/openstenoproject/plover/wiki/Manually-Installing-Plugins for instruction.\n\n* https://github.com/albertz/background-zmq-ipython/issues/13\n* https://github.com/user202729/plover-debugging-console/issues/1#issuecomment-1003654835\n\n### Note\n\n* Once started, the kernel is not stopped until Plover exits.\n* The session (kernel, global variables) are persistent, and shared between consoles.\n  \n  However, `plover-debugging-console-execute \u003cfile\u003e` uses a separate environment, see\n  documentation of `%run` IPython magic command.\n* Any `print` commands are printed on Plover's console, not IPython's console.\n* Error messages might be hidden (if `plover-debugging-console-execute` is used),\n  or displayed in a different console.\n\n  To view the error messages, open an interactive console.\n* On some operating systems, the plugin may set `PAGER` environment variable. (see [issue #2 of `plover-run-shell` repository](https://github.com/user202729/plover_run_shell/issues/2))\n\n### Implementation details\n\n* The kernel can be connected to manually with `ipython console --existing \u003cfile\u003e`\nor `jupyter console --existing \u003cfile\u003e`.\n* The IPython/Jupyter connection file path is stored in `connection_path_container`, which is\n`plover_debugging_console_path` in the temp folder in the current version.\n* `background_zmq_ipython` package is used, which requires `jupyter`\n* Regarding `PAGER`, `GIT_PAGER`, `TERM`, `CLICOLOR` environment variables being set: Either\n   * unset/reset them manually, or\n   * update to a sufficiently new version of package `background-zmq-ipython`, at least commit [14d862848b7f5692412093642181718c29f57cad](https://github.com/albertz/background-zmq-ipython/commit/14d862848b7f5692412093642181718c29f57cad).\n   (version currently not on PyPI)\n* See https://stackoverflow.com/a/68769973/5267751 for the method used in `plover-debugging-console-execute`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuser202729%2Fplover-debugging-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuser202729%2Fplover-debugging-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuser202729%2Fplover-debugging-console/lists"}