xontrib-jupyter 0.3.2

Jupyter Notebook和Jupyter Lab的Xonsh内核允许在笔记本单元中执行xonsh shell命令。

如果您喜欢这个想法，请在repo上点击⭐，并 tweet。

安装

使用 xpip 安装

xpip install xontrib-jupyter
# 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.

检查安装

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

使用方法

Jupyter

只需运行 Jupyter Notebook或JupyterLab 并选择xonsh

jupyter notebook
# or
jupyter lab

Euporie

Euporie 是一个基于终端的交互式计算环境。

euporie-notebook --kernel-name xonsh  # or change the kernel in UI
# or
euporie-console --kernel-name xonsh  # or change the kernel in UI

测试

• 使用其依赖项安装项目

poetry install
poetry install --only-root

• 现在启动xonsh shell

xonsh --no-rc

• 在xonsh shell内部，您可以加载jupyter xontrib并安装内核

xontrib load jupyter

# this will install the kernel
xonfig jupyter-kernel --user

# now start a notebook and choose xonsh kernel
jupyter notebook

发布您的包

1. 将包版本升级到 poetry version patch（或小版本/大版本）

2. 将更改推送到仓库，并使用以下方式发布

   poe release
   

3. 发布说明在每个PR之后自动生成为草稿发布

4. 从草稿发布创建GitHub发布，针对新推送的标签

已知问题

未捕获的输出

在某些情况下，您需要先启用捕获

$XONSH_CAPTURE_ALWAYS = True
$XONSH_SUBPROC_CAPTURED_PRINT_STDERR = True

由于分页器而未捕获的输出

一些工具（如AWS CLI）默认使用无法捕获的 less 分页器来显示输出。在这些情况下，您需要找到禁用分页器的方法，例如，对于AWS CLI设置 $AWS_PAGER = 'cat'。

致谢

• 此包是用xontrib cookiecutter 模板创建的。
• awesome-jupyter - 精选Jupyter项目、库和资源列表。