Skip to main content

A shell for the Jupyter kernel.

Project description

Xonsh provides a kernel for Jupyter Notebook and Lab so you can execute xonsh commands in a notebook cell without any additional magic.

If you like the idea click ⭐ on the repo and tweet.

Installation

To install use pip:

xpip install xontrib-jupyter-shell
# or: xpip install -U git+https://github.com/xonsh/xontrib-jupyter-shell

Usage

$ xontrib load jupyter
$ xonfig jupyter-kernel
Installing Jupyter kernel spec:
  root: None
  prefix: <env_prefix>
  as user: False

<env_prefix> is the path prefix of the Jupyter and Xonsh environment. xonfig jupyter-kernel --help shows options for installing the kernel spec in the user config folder or in a non-standard environment prefix.

You can confirm the status of the installation:

$ xonfig info
+------------------+-----------------------------------------------------+
| xonsh            | 0.9.21                                              |
| Git SHA          | d42b4140                                            |

               . . . . .

| on jupyter       | True                                                |
| jupyter kernel   | <env_prefix>\share\jupyter\kernels\xonsh            |
+------------------+-----------------------------------------------------+

Or:

$ jupyter kernelspec list
Available kernels:
  python3    <env_prefix>\share\jupyter\kernels\python3
  xonsh      <env_prefix>\share\jupyter\kernels\xonsh

Releasing your package

  • Bump the version of your package.
  • Create a GitHub release (The release notes are automatically generated as a draft release after each push).
  • And publish with poetry publish --build or twine

Credits

This package was created with xontrib cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xontrib-jupyter-shell-0.0.2.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

xontrib_jupyter_shell-0.0.2-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file xontrib-jupyter-shell-0.0.2.tar.gz.

File metadata

  • Download URL: xontrib-jupyter-shell-0.0.2.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Darwin/21.4.0

File hashes

Hashes for xontrib-jupyter-shell-0.0.2.tar.gz
Algorithm Hash digest
SHA256 9af8949f2da9457d4998184a4f2e916edbbc882fdfdcfe708a8536fb99ba4530
MD5 c749edc61714365a8705687c9b6d0de6
BLAKE2b-256 f7f81f262505f3c50bbcc38bf214c18038baaa3f44de44380ca361558e679e08

See more details on using hashes here.

File details

Details for the file xontrib_jupyter_shell-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for xontrib_jupyter_shell-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7c1da318cf4d5c0c07c9689d28acb32621a840068051341a63694d820129c802
MD5 f5786f47bc8cfb4313233afe7fee3313
BLAKE2b-256 a22a9b31021bf73332a1df866d7f66f5fb397a0c30cb4310628ac16a8835e5a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page