xontrib-jupyter-shell 0.1.0

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.