https://github.com/user202729/plover-debugging-console
A IPython debugging console for Plover.
https://github.com/user202729/plover-debugging-console
plover plover-plugins
Last synced: about 1 month ago
JSON representation
A IPython debugging console for Plover.
- Host: GitHub
- URL: https://github.com/user202729/plover-debugging-console
- Owner: user202729
- License: gpl-3.0
- Created: 2021-07-16T05:06:22.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-13T15:34:21.000Z (about 3 years ago)
- Last Synced: 2025-02-14T11:02:13.594Z (3 months ago)
- Topics: plover, plover-plugins
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# plover-debugging-console
A IPython debugging console for Plover.
See also:
* [`plover-run-py` plugin](https://github.com/user202729/plover-run-py) for
executing a Python command with a stroke, or from the command-line.
### Usage
* Install the plugin.
* Enable the extension plugin in Plover.
* Run the command `plover-debugging-console-connect` (or `plover -s plover-debugging-console-connect`)
in a terminal.
The global variable `engine` is given. Other objects can be accessed from `engine` as public
or private members.
Alternatively, `plover-debugging-console-connect qtconsole` can be used to launch a console-style application using Qt.
See documentation of `jupyter qtconsole` for more details.
Or `plover-debugging-console-execute` can be used to execute a file non-interactively. See note below.
### Known issues
Those errors can be fixed by installing the latest version of `background_zmq_ipython` manually on GitHub. Refer to
https://github.com/openstenoproject/plover/wiki/Manually-Installing-Plugins for instruction.
* https://github.com/albertz/background-zmq-ipython/issues/13
* https://github.com/user202729/plover-debugging-console/issues/1#issuecomment-1003654835
### Note
* Once started, the kernel is not stopped until Plover exits.
* The session (kernel, global variables) are persistent, and shared between consoles.
However, `plover-debugging-console-execute ` uses a separate environment, see
documentation of `%run` IPython magic command.
* Any `print` commands are printed on Plover's console, not IPython's console.
* Error messages might be hidden (if `plover-debugging-console-execute` is used),
or displayed in a different console.
To view the error messages, open an interactive console.
* 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))
### Implementation details
* The kernel can be connected to manually with `ipython console --existing `
or `jupyter console --existing `.
* The IPython/Jupyter connection file path is stored in `connection_path_container`, which is
`plover_debugging_console_path` in the temp folder in the current version.
* `background_zmq_ipython` package is used, which requires `jupyter`
* Regarding `PAGER`, `GIT_PAGER`, `TERM`, `CLICOLOR` environment variables being set: Either
* unset/reset them manually, or
* update to a sufficiently new version of package `background-zmq-ipython`, at least commit [14d862848b7f5692412093642181718c29f57cad](https://github.com/albertz/background-zmq-ipython/commit/14d862848b7f5692412093642181718c29f57cad).
(version currently not on PyPI)
* See https://stackoverflow.com/a/68769973/5267751 for the method used in `plover-debugging-console-execute`.