| Name | jupyterlite-xeus-python JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | A Python kernel for JupyterLite, powered by Xeus |
| upload_time | 2023-12-13 09:38:26 |
| maintainer | |
| docs_url | None |
| author | JupyterLite Contributors |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2021, Thorsten Beier Copyright (c) 2021-2023, JupyterLite Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlite-xeus-python
[![ci-badge]][ci] [![docs-badge]][docs]
[ci-badge]: https://github.com/jupyterlite/xeus-python-kernel/workflows/Build/badge.svg
[ci]: https://github.com/jupyterlite/xeus-python-kernel/actions?query=branch%3Amain
[docs-badge]: https://readthedocs.org/projects/xeus-python-kernel/badge/?version=latest
[docs]: https://xeus-python-kernel.readthedocs.io/en/latest/?badge=latest
The [xeus-python](https://github.com/jupyter-xeus/xeus-python) Python kernel for JupyterLite running in the browser.
## Install
You can install the kernel with conda/mamba:
```bash
mamba install -c conda-forge jupyterlite-xeus-python
```
Or using pip:
```bash
pip install jupyterlite-xeus-python
```
Then build your JupyterLite site:
```bash
jupyter lite build
```
## Pre-installed packages
xeus-python allows you to pre-install packages in the Python runtime. You can pre-install packages by adding an `environment.yml` file in the JupyterLite build directory, this file will be found automatically by xeus-python which will pre-build the environment when running `jupyter lite build`.
Furthermore, this automatically installs any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.
Say you want to install `NumPy`, `Matplotlib` and `ipycanvas`, it can be done by creating the `environment.yml` file with the following content:
```yml
name: xeus-python-kernel
channels:
- https://repo.mamba.pm/emscripten-forge
- conda-forge
dependencies:
- numpy
- matplotlib
- ipycanvas
```
Then you only need to build JupyterLite:
```bash
jupyter lite build
```
You can also pick another name for that environment file (_e.g._ `custom.yml`), by doing so, you will need to specify that name to xeus-python:
```bash
jupyter lite build --XeusPythonEnv.environment_file=custom.yml
```
## Contributing
### Development install
Note: You will need NodeJS to build the extension package.
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Change directory to the jupyterlite-xeus-python directory
# Install package in development mode
python -m pip install -e ".[dev]"
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build
```
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab
```
With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
### Development uninstall
```bash
pip uninstall jupyterlite-xeus-python
```
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterlite-xeus-python` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlite-xeus-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "JupyterLite Contributors",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a5/82/1f04adb961cc1a85fe3c193360132a252e2ca64c79ceb162de3418d16a02/jupyterlite_xeus_python-1.0.0.tar.gz",
"platform": null,
"description": "# jupyterlite-xeus-python\n\n[![ci-badge]][ci] [![docs-badge]][docs]\n\n[ci-badge]: https://github.com/jupyterlite/xeus-python-kernel/workflows/Build/badge.svg\n[ci]: https://github.com/jupyterlite/xeus-python-kernel/actions?query=branch%3Amain\n[docs-badge]: https://readthedocs.org/projects/xeus-python-kernel/badge/?version=latest\n[docs]: https://xeus-python-kernel.readthedocs.io/en/latest/?badge=latest\n\nThe [xeus-python](https://github.com/jupyter-xeus/xeus-python) Python kernel for JupyterLite running in the browser.\n\n\n\n## Install\n\nYou can install the kernel with conda/mamba:\n\n```bash\nmamba install -c conda-forge jupyterlite-xeus-python\n```\n\nOr using pip:\n\n```bash\npip install jupyterlite-xeus-python\n```\n\nThen build your JupyterLite site:\n\n```bash\njupyter lite build\n```\n\n## Pre-installed packages\n\nxeus-python allows you to pre-install packages in the Python runtime. You can pre-install packages by adding an `environment.yml` file in the JupyterLite build directory, this file will be found automatically by xeus-python which will pre-build the environment when running `jupyter lite build`.\n\nFurthermore, this automatically installs any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.\n\nSay you want to install `NumPy`, `Matplotlib` and `ipycanvas`, it can be done by creating the `environment.yml` file with the following content:\n\n```yml\nname: xeus-python-kernel\nchannels:\n - https://repo.mamba.pm/emscripten-forge\n - conda-forge\ndependencies:\n - numpy\n - matplotlib\n - ipycanvas\n```\n\nThen you only need to build JupyterLite:\n\n```bash\njupyter lite build\n```\n\nYou can also pick another name for that environment file (_e.g._ `custom.yml`), by doing so, you will need to specify that name to xeus-python:\n\n```bash\njupyter lite build --XeusPythonEnv.environment_file=custom.yml\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupyterlite-xeus-python directory\n# Install package in development mode\npython -m pip install -e \".[dev]\"\n\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n\n# Rebuild extension Typescript source after making changes\njlpm run build\n```\n\nYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).\n\n### Development uninstall\n\n```bash\npip uninstall jupyterlite-xeus-python\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupyterlite-xeus-python` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2021, Thorsten Beier Copyright (c) 2021-2023, JupyterLite Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A Python kernel for JupyterLite, powered by Xeus",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlite/xeus-python-kernel/issues",
"Homepage": "https://github.com/jupyterlite/xeus-python-kernel",
"Repository": "https://github.com/jupyterlite/xeus-python-kernel.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8e6d4fe8e4d9bd31688d393fdb7052bb0c897726f2f8f042a40788353e7b8e3",
"md5": "56dc48daebded862762ef7df3cfec528",
"sha256": "0be2393d3f738ecc920c6b5ec261c83d0ff2a1d79cdf5b8167dcdb95464b7e86"
},
"downloads": -1,
"filename": "jupyterlite_xeus_python-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56dc48daebded862762ef7df3cfec528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14450368,
"upload_time": "2023-12-13T09:38:19",
"upload_time_iso_8601": "2023-12-13T09:38:19.202046Z",
"url": "https://files.pythonhosted.org/packages/d8/e6/d4fe8e4d9bd31688d393fdb7052bb0c897726f2f8f042a40788353e7b8e3/jupyterlite_xeus_python-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5821f04adb961cc1a85fe3c193360132a252e2ca64c79ceb162de3418d16a02",
"md5": "cc0f273747bfaf283b8518ac5236a2b0",
"sha256": "bc8865f38e799b8833871257ca70d3b76574ea81391ba82324d99b3afcb81633"
},
"downloads": -1,
"filename": "jupyterlite_xeus_python-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "cc0f273747bfaf283b8518ac5236a2b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14613437,
"upload_time": "2023-12-13T09:38:26",
"upload_time_iso_8601": "2023-12-13T09:38:26.932008Z",
"url": "https://files.pythonhosted.org/packages/a5/82/1f04adb961cc1a85fe3c193360132a252e2ca64c79ceb162de3418d16a02/jupyterlite_xeus_python-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-13 09:38:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlite",
"github_project": "xeus-python-kernel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlite-xeus-python"
}
