{"author":null,"author_email":"Thomas Kluyver ","bugtrack_url":null,"classifiers":["Framework :: Jupyter","License :: OSI Approved :: BSD License","Programming Language :: Python :: 3","Topic :: System :: Shells"],"description":".. image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/takluyver/bash_kernel/master\n\n=========================\nA Jupyter kernel for bash\n=========================\n\nInstallation\n------------\nThis requires IPython 3.\n\n.. code:: shell\n\n pip install bash_kernel\n python -m bash_kernel.install\n\nTo use it, run one of:\n\n.. code:: shell\n\n jupyter notebook\n # In the notebook interface, select Bash from the 'New' menu\n jupyter qtconsole --kernel bash\n jupyter console --kernel bash\n\n\n`pipx` and \"externally managed\" environments\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nA recent-ish `PEP 668 `_ recommends that users install Python applications with `pipx` rather than global installs with `pip`. This is strongly suggested/enforced in current Linux distros. Because `bash_kernel` needs an extra step to actually work after installing with `pip` or `pipx`, this causes some inconvenience.\n\nFirst, one must install the Jupyter ecosystem with pipx, and then inject bash_kernel (and any other bits of the jupyter ecosystem you use, like papermill) into the same pipx venv.\n\n.. code:: shell\n\n pipx install --include-deps jupyter\n pipx inject --include-apps --include-deps jupyter bash_kernel\n\nOne then must manually find the corresponding venv, activate it, and run `python -m bash_kernel.install` *within* that virtual env. If done outside it, this won't work as bash_kernel is not installed in the global environment.\n\n.. code:: shell\n\n cd ~/.local/pipx/venvs/jupyter/\n source bin/activate\n python -m bash_kernel.install\n deactivate\n\nOf course, one can also install bash_kernel to the global environement thusly:\n\n.. code:: shell\n\n pip install --break-system-packages juptyer bash_kernel\n python -m bash_kernel.install\n\nRequirements of Bash\n~~~~~~~~~~~~~~~~~~~~\n\nBash kernel directly interacts with bash, and therefore requires a functioning interactive build of bash. In nearly all cases this will be the default, however some distributions remove GNU readline or other interactivity features of bash. Almost always, these features are provided in a separate, more complete bash package, which should be installed. See for example https://github.com/takluyver/bash_kernel/issues/142.\n\nDisplaying Rich Content\n-----------------------\n\nTo use specialized content (images, html, etc) this file defines (in `build_cmds()`) bash functions\nthat take the contents as standard input. Currently, `display` (images), `displayHTML` (html)\nand `displayJS` (javascript) are supported.\n\nExample:\n\n.. code:: shell\n\n cat dog.png | display\n echo \"Dog, not a cat.\" | displayHTML\n echo \"alert('Hello from bash_kernel\\!');\" | displayJS\n\nUpdating Rich Content Cells\n---------------------------\n\nIf one is doing something that requires dynamic updates, one can specify a unique display_id,\nwhich should be a string name. On each update, the contents will be replaced by the new value. Example:\n\n.. code:: shell\n\n display_id=\"id_${RANDOM}\"\n ((ii=0))\n while ((ii < 10)) ; do\n echo \"

${ii}

\" | displayHTML $display_id\n ((ii = ii+1))\n sleep 1\n done\n\nThe same works for images and javascript content.\n\n**Remember to create always a new id** each time the cell is executed, otherwise it will try to display\non an HTML element that no longer exists (they are erased each time a cell is re-run).\n\nProgrammatically Generating Rich Content\n----------------------------------------\n\nAlternatively one can simply generate the rich content to a file in /tmp (or $TMPDIR)\nand then output the corresponding (to the mimetype) context prefix ``\"_TEXT_SAVED_*\"``\nconstant. So one can write programs (C++, Go, Rust, etc.) that generates rich content\nappropriately, when within a notebook.\n\nThe environment variable \"NOTEBOOK_BASH_KERNEL_CAPABILITIES\" will be set with a comma\nseparated list of the supported types (currently \"image,html,javascript\") that a program\ncan check for.\n\nTo output to a particular \"display_id\", to allow update of content (e.g: dynamically\nupdating/generating a plot from a command line program), prefix the filename\nwith \"()\". E.g: a line to display the contents of /tmp/myHTML.html to\na display id \"id_12345\" would look like:\n\n bash_kernel: saved html data to: (id_12345) /tmp/myHTML.html\n\nMore Information\n----------------\n\nFor details of how this works, see the Jupyter docs on `wrapper kernels\n`_, and\nPexpect's docs on the `replwrap module\n`_.\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"bash_kernel","package_url":"https://pypi.org/project/bash_kernel/","platform":null,"project_url":"https://pypi.org/project/bash_kernel/","project_urls":{"Source":"https://github.com/takluyver/bash_kernel"},"provides_extra":null,"release_url":"https://pypi.org/project/bash_kernel/0.10.0/","requires_dist":["pexpect>=4.0","ipykernel","filetype"],"requires_python":null,"summary":"A bash kernel for Jupyter","version":"0.10.0","yanked":false,"yanked_reason":null}

Dependencies of bash_kernel (3).
Dependency	Optional
filetype	false
ipykernel	false
pexpect	false

Package search

bash_kernel

project_urls

Dependencies

All package metadata

Releases