<p align="center">
Xonsh provides a kernel for Jupyter Notebook and Lab so you can execute
xonsh commands in a notebook cell without any additional magic.
</p>
<p align="center">
If you like the idea click ⭐ on the repo and <a href="https://twitter.com/intent/tweet?text=Nice%20xontrib%20for%20the%20xonsh%20shell!&url=https://github.com/xonsh/xontrib-jupyter-shell" target="_blank">tweet</a>.
</p>
## Installation
To install use [xpip](https://xon.sh/aliases.html#xpip):
```xsh
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:
```xsh
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](https://jupyter.org/) and choose xonsh:
```xsh
jupyter notebook
jupyter lab
```
### Euporie
[Euporie](https://github.com/joouha/euporie) is a terminal based interactive computing environment.
```xsh
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](https://github.com/xonsh/xontrib-cookiecutter).
Raw data
{
"_id": null,
"home_page": "https://github.com/xonsh/xontrib-jupyter-shell",
"name": "xontrib-jupyter-shell",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "xontrib,xonsh",
"author": "Xonsh Dev",
"author_email": "jnoortheen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4d/8d/0ec213f3ce2c35eda60632d385edbd532a1fdfbf64af92cb2eb056fd1cb2/xontrib_jupyter_shell-0.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\nXonsh provides a kernel for Jupyter Notebook and Lab so you can execute\nxonsh commands in a notebook cell without any additional magic.\n</p>\n\n<p align=\"center\">\nIf you like the idea click \u2b50 on the repo and <a href=\"https://twitter.com/intent/tweet?text=Nice%20xontrib%20for%20the%20xonsh%20shell!&url=https://github.com/xonsh/xontrib-jupyter-shell\" target=\"_blank\">tweet</a>.\n</p>\n\n\n## Installation\n\nTo install use [xpip](https://xon.sh/aliases.html#xpip):\n\n```xsh\nxpip install xontrib-jupyter-shell\n# or: xpip install -U git+https://github.com/xonsh/xontrib-jupyter\n\nxontrib load jupyter\nxonfig jupyter-kernel --help # Options for installing.\nxonfig jupyter-kernel --user # Install kernel spec in user config directory.\n```\n\nCheck the installation:\n```xsh\njupyter kernelspec list\n# Available kernels:\n# python3 /opt/homebrew/lib/python3.11/site-packages/ipykernel/resources\n# xonsh /PATH_TO_ENV_PREFIX/share/jupyter/kernels/xonsh\n\nxontrib load jupyter\nxonfig jupyter-kernel\n# Installing Jupyter kernel spec:\n# root: None\n# prefix: /PATH_TO_ENV_PREFIX/\n# as user: False\n\nxonfig info\n#| jupyter | True\n#| jupyter kernel | /PATH_TO_ENV_PREFIX/share/jupyter/kernels/xonsh\n\n```\n\n## Usage\n\n### Jupyter\n\nJust run [Jupyter Notebook or JupyterLab](https://jupyter.org/) and choose xonsh:\n\n```xsh\njupyter notebook\njupyter lab\n```\n\n### Euporie\n\n[Euporie](https://github.com/joouha/euporie) is a terminal based interactive computing environment.\n\n```xsh\neuporie-notebook\n# Change the kernel to xonsh\n```\n\n## Releasing your package \n\n1. Bump the version of the package.\n2. The release notes are automatically generated as a draft release after each PR.\n3. Create a GitHub release. \n4. Publish with `poetry publish --build` or `twine`.\n\n## Credits\n\nThis package was created with [xontrib cookiecutter template](https://github.com/xonsh/xontrib-cookiecutter).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A shell for the Jupyter kernel.",
"version": "0.1.0",
"split_keywords": [
"xontrib",
"xonsh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad0badbc52852a492e6a5660595c5d1c47ad827185948009282a5a90afd9969f",
"md5": "94621210779afc1d13d104b5c5ce5dff",
"sha256": "7eb0c59b4ee9b0d4b81b7fe61443d8c9d5f52b0d562e0c3bee3a8e855398dc42"
},
"downloads": -1,
"filename": "xontrib_jupyter_shell-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94621210779afc1d13d104b5c5ce5dff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11035,
"upload_time": "2023-03-17T04:56:25",
"upload_time_iso_8601": "2023-03-17T04:56:25.765297Z",
"url": "https://files.pythonhosted.org/packages/ad/0b/adbc52852a492e6a5660595c5d1c47ad827185948009282a5a90afd9969f/xontrib_jupyter_shell-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4d8d0ec213f3ce2c35eda60632d385edbd532a1fdfbf64af92cb2eb056fd1cb2",
"md5": "2d106f76e4097999c6c872f5a1df316d",
"sha256": "3ab936a13cc7da4a37a0826e231c3008e32b127f16886ea39c859ea141a3db00"
},
"downloads": -1,
"filename": "xontrib_jupyter_shell-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2d106f76e4097999c6c872f5a1df316d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10631,
"upload_time": "2023-03-17T04:56:27",
"upload_time_iso_8601": "2023-03-17T04:56:27.157007Z",
"url": "https://files.pythonhosted.org/packages/4d/8d/0ec213f3ce2c35eda60632d385edbd532a1fdfbf64af92cb2eb056fd1cb2/xontrib_jupyter_shell-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-17 04:56:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "xonsh",
"github_project": "xontrib-jupyter-shell",
"lcname": "xontrib-jupyter-shell"
}
JSON
