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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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