Skip to main content

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 xpip:

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

xontrib load jupyter
xonfig jupyter-kernel --help  # Options for installing.
xonfig jupyter-kernel --user  # Install kernel spec in user config directory.

Check the installation:

jupyter kernelspec list
# Available kernels:
#  python3    /opt/homebrew/lib/python3.11/site-packages/ipykernel/resources
#  xonsh      /PATH_TO_ENV_PREFIX/share/jupyter/kernels/xonsh

xontrib load jupyter
xonfig jupyter-kernel
# Installing Jupyter kernel spec:
#  root: None
#  prefix: /PATH_TO_ENV_PREFIX/
#  as user: False

xonfig info
#| jupyter          | True
#| jupyter kernel   | /PATH_TO_ENV_PREFIX/share/jupyter/kernels/xonsh

Usage

Jupyter

Just run Jupyter Notebook or JupyterLab and choose xonsh:

jupyter notebook
jupyter lab

Euporie

Euporie is a terminal based interactive computing environment.

euporie-notebook
# Change the kernel to xonsh

Releasing your package

  1. Bump the version of the package.
  2. The release notes are automatically generated as a draft release after each PR.
  3. Create a GitHub release.
  4. Publish with poetry publish --build or twine.

Credits

This package was created with xontrib cookiecutter template.

Metadata

Release files for xontrib-jupyter-shell 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xontrib-jupyter-shell 0.1.0
File Size Uploaded
xontrib_jupyter_shell-0.1.0.tar.gz 10.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for xontrib-jupyter-shell 0.1.0
File Interpreter ABI Platform
xontrib_jupyter_shell-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 21.7 kB

Release files / xontrib_jupyter_shell-0.1.0.tar.gz

Download URL xontrib_jupyter_shell-0.1.0.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3ab936a13cc7da4a37a0826e231c3008e32b127f16886ea39c859ea141a3db00
BLAKE2b-256 checksum
How to use checksums
4d8d0ec213f3ce2c35eda60632d385edbd532a1fdfbf64af92cb2eb056fd1cb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.11.2 Darwin/22.3.0

Release files / xontrib_jupyter_shell-0.1.0-py3-none-any.whl

Download URL xontrib_jupyter_shell-0.1.0-py3-none-any.whl
Size 11.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7eb0c59b4ee9b0d4b81b7fe61443d8c9d5f52b0d562e0c3bee3a8e855398dc42
BLAKE2b-256 checksum
How to use checksums
ad0badbc52852a492e6a5660595c5d1c47ad827185948009282a5a90afd9969f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.0 CPython/3.11.2 Darwin/22.3.0

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page