Z shell kernel for Jupyter Notebook

dan-oak, updated 🕥 2023-02-11 01:54:37

zsh kernel for jupyter

screenshot

a simple z shell jupyter kernel powered by python 3, pexpect and enthusiasm.

i love experimentation and tinkering, but usual shell terminals do not allow developing multiple different code snippets at once conveniently. with shell kernels you can turn your scripts into notebooks!

if you find this product useful, please consider supporting me with a one-time tip.

feedback and suggestions are welcome in github issues.

installation

install the python package from pypi using available package manager like pip or pipenv

(optional) by default the installation script will install the package and the kernel. the kernel location will be the same as the python environment from which the installation is done. check python -m zsh_jupyter_kernel.install -h for possible installation options if you want to install the kernel in a different environment or to change display name.

pipenv

sh pipenv --python 3.10 install notebook zsh_jupyter_kernel

pip

sh python -m pip install notebook zsh_jupyter_kernel

usage

expect the kernel to work as usual including your zsh configs except without stdin (user input) support and prompt line and in the boundaries of the current jupyter limitations like not all ansi codes will work in certain cases ('\r') and in general things that expect terminal will have unexpected behavior. see below why user input is not supported.

technical overview

the kernel launches zsh as if it was a regular process launched from your terminal with a few minor settings to make sure it works with jupyter. there is slight chance it wont work with super complicated zshrc setups, but it works with majority of configs including oh-my-zsh.

how does code execution work

the kernel configures zsh prompt string to its own custom value. when a user requests a cell execution, the code is sent to the kernel. then the kernel puts the frontend on hold, sends the code to zsh process, and waits for the prompt string to release the frontend and let the user request more code execution.

code completion

code completion is powered by quite a non-trivial script that involves multiple steps, including spawning another temporary zsh process and capturing completion options into a data structure that jupyter frontend understands.

code inspection

code inspection is done by man --pager ul which sends the whole man page to the frontend.

code completeness

code completeness is checked with the temporary zsh process and help of EXEC zsh option, which allows switching off code execution and simply check if the code is complete using the exit code of the zsh process itself.

stderr

stderr content is just sent to the front-end as regular stdout the same way it is in a terminal.

stdin

stdin is not supported because of the execution system when a process spawned by a user waits for stdin, there is no way to detect it.

jupyter is a request-reply system, and zsh as a shell that constantly receives input and prints whatever current processes want to output. there is no clear start and end of a code execution in a shell unlike in jupyter system: a front-end sends a code from a cell to a kernel and waits until the kernel sends the full output back.

because of these two different ways of interacting with user zsh jupyter kernel cannot process stdin in a way python kernel does on input(), meaning you will not be able to enter a sudo password or answer y/n to prompts or use a pager like less. when a spawned program waits for a user input, you will need to interrupt the kernel and use any options which do not require input.

troubleshooting

please let me know if you encounter an error or unexpected behavior using github issues. i will respond as soon as possible.

Issues

Bump ipython from 8.4.0 to 8.10.0

opened on 2023-02-11 01:54:37 by dependabot[bot]

Bumps ipython from 8.4.0 to 8.10.0.

Commits

15ea1ed release 8.10.0
560ad10 DOC: Update what's new for 8.10 (#13939)
7557ade DOC: Update what's new for 8.10
385d693 Merge pull request from GHSA-29gw-9793-fvw7
e548ee2 Swallow potential exceptions from showtraceback() (#13934)
0694b08 MAINT: mock slowest test. (#13885)
8655912 MAINT: mock slowest test.
a011765 Isolate the attack tests with setUp and tearDown methods
c7a9470 Add some regression tests for this change
fd34cf5 Swallow potential exceptions from showtraceback()
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/dan-oak/zsh-jupyter-kernel/network/alerts).

Bump setuptools from 63.3.0 to 65.5.1

opened on 2022-12-27 17:02:58 by dependabot[bot]

Bumps setuptools from 63.3.0 to 65.5.1.

Changelog

Sourced from setuptools's changelog.

v65.5.1

Misc ^^^^

#3638: Drop a test dependency on the mock package, always use :external+python:py:mod:unittest.mock -- by :user:hroncok

#3659: Fixed REDoS vector in package_index.

v65.5.0

Changes ^^^^^^^

#3624: Fixed editable install for multi-module/no-package src-layout projects.

#3626: Minor refactorings to support distutils using stdlib logging module.

Documentation changes ^^^^^^^^^^^^^^^^^^^^^

#3419: Updated the example version numbers to be compliant with PEP-440 on the "Specifying Your Project’s Version" page of the user guide.

Misc ^^^^

#3569: Improved information about conflicting entries in the current working directory and editable install (in documentation and as an informational warning).

#3576: Updated version of validate_pyproject.

v65.4.1

Misc ^^^^

#3613: Fixed encoding errors in expand.StaticModule when system default encoding doesn't match expectations for source files.

#3617: Merge with pypa/[email protected] including fix for pypa/distutils#181.

v65.4.0

Changes ^^^^^^^

#3609: Merge with pypa/[email protected] including support for DIST_EXTRA_CONFIG in pypa/distutils#177.

v65.3.0

... (truncated)

Commits

a462cb5 Bump version: 65.5.0 → 65.5.1
de35d8b Merge pull request #3656 from bmorris3/typos
58e23de Update changelog. Ref #3659.
43a9c9b Limit the amount of whitespace to search/backtrack. Fixes #3659.
5791343 Add test capturing failed expectation. Ref #3659.
1f97905 ⚫ Fade to black.
6254567 Remove workaround for emacs.
729b180 ⚫ Fade to black.
c068081 Typo corrections
f777a40 Suppress deprecation warning in --rsyncdir. Workaround for #3655.
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

Bump certifi from 2022.6.15 to 2022.12.7

opened on 2022-12-09 07:20:51 by dependabot[bot]

Bumps certifi from 2022.6.15 to 2022.12.7.

Commits

9e9e840 2022.12.07
b81bdb2 2022.09.24
939a28f 2022.09.14
aca828a 2022.06.15.2
de0eae1 Only use importlib.resources's new files() / Traversable API on Python ≥3.11 ...
b8eb5e9 2022.06.15.1
47fb7ab Fix deprecation warning on Python 3.11 (#199)
b0b48e0 fixes #198 -- update link in license
See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

add in missing kernel installation command

opened on 2022-11-13 07:49:43 by Kvieta1990 None

Bump nbconvert from 6.5.0 to 6.5.1

opened on 2022-08-23 19:20:10 by dependabot[bot]

Bumps nbconvert from 6.5.0 to 6.5.1.

Commits

7471b75 Release 6.5.1
c1943e0 Fix pre-commit
8685e93 Fix tests
0abf290 Run black and prettier
418d545 Run test on 6.x branch
bef65d7 Convert input to string prior to escape HTML
0818628 Check input type before escaping
b206470 GHSL-2021-1017, GHSL-2021-1020, GHSL-2021-1021
a03cbb8 GHSL-2021-1026, GHSL-2021-1025
48fe71e GHSL-2021-1024
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

dan-oak

Check my game available at Google Play Store.

GitHub Repository

ipython-kernel jupyter-kernel jupyter ipython zsh