| Name | jupyterlite-pyodide-kernel JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Python kernel for JupyterLite powered by Pyodide |
| upload_time | 2024-03-30 13:52:59 |
| maintainer | None |
| docs_url | None |
| author | JupyterLite Contributors |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c), 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 |
browser
jupyter
jupyterlab
jupyterlite
notebook
pyodide
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlite-pyodide-kernel
> A Python kernel for [JupyterLite](https://jupyterlite.rtfd.io) powered by
> [Pyodide](https://pyodide.org),
[![ci-badge]][ci] [![lite-badge]][lite] [![docs-badge]][docs]
[ci-badge]: https://github.com/jupyterlite/pyodide-kernel/workflows/Build/badge.svg
[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg
[lite]: https://jupyterlite-pyodide-kernel.rtfd.io/en/latest/_static
[ci]: https://github.com/jupyterlite/pyodide-kernel/actions?query=branch%3Amain
[docs-badge]:
https://readthedocs.org/projects/jupyterlite-pyodide-kernel/badge/?version=latest
[docs]: https://jupyterlite-pyodide-kernel.readthedocs.io/en/latest/?badge=latest
## Requirements
- `python >=3.8`
### Compatibility
#### With Jupyter
| status | `jupyterlite-pyodide-kernel` | `jupyterlite-core` | `jupyterlab` | `notebook` | `retrolab` |
| :----: | :--------------------------: | :----------------: | :------------: | :------------: | :----------: |
| stable | `0.3.*` | `>=0.3,<0.4` | `>=4.1.1,<4.2` | `>=7.1.0,<7.2` | - |
| stable | `0.2.*` | `>=0.2,<0.3` | `>=4.0.7,<4.1` | `>=7.0.5,<8` | - |
| stable | `0.1.*` | `>=0.1,<0.2` | `>=3.5,<3.6` | - | `>=0.3,<0.4` |
Installing the matching version of JupyterLab with your package manager can help ensure
matching labextension assets and kernel dependencies, even though this kernel does not
yet work in a full, `jupyter_server`-hosted client such as JupyterLab or Notebook.
#### With Pyodide
| `jupyterlite-pyodide-kernel` | `pyodide` | `python` | `emscripten` |
| :--------------------------: | :-------: | :------: | :----------: |
| `>=0.1.0,<=0.1.1` | `0.23.*` | `3.10.*` | `3.1.29` |
| `>=0.1.2,<=0.2.1` | `0.24.*` | `3.10.*` | `3.1.45` |
| `>=0.2.2,<=0.2.3` | `0.25.*` | `3.11.*` | `3.1.46` |
| `>=0.3.*,<=0.4.0` | `0.25.*` | `3.11.*` | `3.1.46` |
Note that the Emscripten version is strict down to the bugfix version.
## Install
To install the Pyodide kernel labextension and the CLI addons for `jupyter lite`, run:
```bash
pip install jupyterlite-pyodide-kernel
```
or with `conda`, `mamba`, `micromamba`, etc.
```bash
conda install -c conda-forge jupyterlite-pyodide-kernel
```
> For more options see the [development install](#development-install) or [contributing
> guide][contrib].
## Usage
Build a JupyterLite site:
```bash
jupyter lite build
```
Some new CLI options are also available:
```bash
jupyter lite --help
```
This should show something like this:
```bash
--piplite-wheels=<typedtuple-item-1>...
Local paths or URLs of piplite-compatible wheels to copy and index
Default: ()
Equivalent to: [--PipliteAddon.piplite_urls]
--pyodide=<Unicode>
Local path or URL of a pyodide distribution tarball
Default: ''
Equivalent to: [--PyodideAddon.pyodide_url]
```
## Learn more
⚠️ The documentation for advanced configuration is available from the main JupyterLite
documentation site:
- [configuring]
- [command line interface][cli]
[configuring]:
https://jupyterlite.readthedocs.io/en/latest/howto/index.html#configuring-the-python-environment
[cli]: https://jupyterlite.readthedocs.io/en/latest/reference/cli.html
## Uninstall
To remove the extension, run:
```bash
pip uninstall jupyterlite-pyodide-kernel # or however you installed it
```
## Prerelease Versions
To install pre-release versions with `pip`:
```bash
pip install --upgrade --pre jupyterlite-pyodide-kernel
```
Or, similarly for the `conda` ecosystem, for `alpha` packages:
```bash
conda install \
-c conda-forge/label/jupyterlite_core_alpha \
-c conda-forge/label/jupyterlite_pyodide_kernel_alpha \
-c conda-forge \
jupyterlite-pyodide-kernel
```
> Note: `_beta` and `_rc` packages would follow a similar channel naming convention
## Development Install
Below is an short overview of getting up and running quickly. Please see the
[contributing guide][contrib] for full details.
### Development Requirements
**Recommended** a Python virtual environment provided by a tool of choice, e.g. one of:
- `virtualenv`
- `mamba`
- `conda`
Ensure the local development environment has:
- `git`
- `nodejs 20`
- `python >=3.8`
### Development Quick Start
```bash
git clone https://github.com/jupyterlite/pyodide-kernel
cd pyodide-kernel
npm run quickstart
```
Then, serve the built demo site, documentation, and test reports with Python's built-in
HTTP server:
```bash
jlpm serve
```
[contrib]: https://github.com/jupyterlite/pyodide-kernel/blob/main/CONTRIBUTING.md
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlite-pyodide-kernel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "browser, jupyter, jupyterlab, jupyterlite, notebook, pyodide",
"author": "JupyterLite Contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/05/c8/cadab766854b2a728ad8376078cc297977fc577213cb587ada448aea4e44/jupyterlite_pyodide_kernel-0.3.1.tar.gz",
"platform": null,
"description": "# jupyterlite-pyodide-kernel\n\n> A Python kernel for [JupyterLite](https://jupyterlite.rtfd.io) powered by\n> [Pyodide](https://pyodide.org),\n\n[![ci-badge]][ci] [![lite-badge]][lite] [![docs-badge]][docs]\n\n[ci-badge]: https://github.com/jupyterlite/pyodide-kernel/workflows/Build/badge.svg\n[lite-badge]: https://jupyterlite.rtfd.io/en/latest/_static/badge.svg\n[lite]: https://jupyterlite-pyodide-kernel.rtfd.io/en/latest/_static\n[ci]: https://github.com/jupyterlite/pyodide-kernel/actions?query=branch%3Amain\n[docs-badge]:\n https://readthedocs.org/projects/jupyterlite-pyodide-kernel/badge/?version=latest\n[docs]: https://jupyterlite-pyodide-kernel.readthedocs.io/en/latest/?badge=latest\n\n## Requirements\n\n- `python >=3.8`\n\n### Compatibility\n\n#### With Jupyter\n\n| status | `jupyterlite-pyodide-kernel` | `jupyterlite-core` | `jupyterlab` | `notebook` | `retrolab` |\n| :----: | :--------------------------: | :----------------: | :------------: | :------------: | :----------: |\n| stable | `0.3.*` | `>=0.3,<0.4` | `>=4.1.1,<4.2` | `>=7.1.0,<7.2` | - |\n| stable | `0.2.*` | `>=0.2,<0.3` | `>=4.0.7,<4.1` | `>=7.0.5,<8` | - |\n| stable | `0.1.*` | `>=0.1,<0.2` | `>=3.5,<3.6` | - | `>=0.3,<0.4` |\n\nInstalling the matching version of JupyterLab with your package manager can help ensure\nmatching labextension assets and kernel dependencies, even though this kernel does not\nyet work in a full, `jupyter_server`-hosted client such as JupyterLab or Notebook.\n\n#### With Pyodide\n\n| `jupyterlite-pyodide-kernel` | `pyodide` | `python` | `emscripten` |\n| :--------------------------: | :-------: | :------: | :----------: |\n| `>=0.1.0,<=0.1.1` | `0.23.*` | `3.10.*` | `3.1.29` |\n| `>=0.1.2,<=0.2.1` | `0.24.*` | `3.10.*` | `3.1.45` |\n| `>=0.2.2,<=0.2.3` | `0.25.*` | `3.11.*` | `3.1.46` |\n| `>=0.3.*,<=0.4.0` | `0.25.*` | `3.11.*` | `3.1.46` |\n\nNote that the Emscripten version is strict down to the bugfix version.\n\n## Install\n\nTo install the Pyodide kernel labextension and the CLI addons for `jupyter lite`, run:\n\n```bash\npip install jupyterlite-pyodide-kernel\n```\n\nor with `conda`, `mamba`, `micromamba`, etc.\n\n```bash\nconda install -c conda-forge jupyterlite-pyodide-kernel\n```\n\n> For more options see the [development install](#development-install) or [contributing\n> guide][contrib].\n\n## Usage\n\nBuild a JupyterLite site:\n\n```bash\njupyter lite build\n```\n\nSome new CLI options are also available:\n\n```bash\njupyter lite --help\n```\n\nThis should show something like this:\n\n```bash\n --piplite-wheels=<typedtuple-item-1>...\n Local paths or URLs of piplite-compatible wheels to copy and index\n Default: ()\n Equivalent to: [--PipliteAddon.piplite_urls]\n --pyodide=<Unicode>\n Local path or URL of a pyodide distribution tarball\n Default: ''\n Equivalent to: [--PyodideAddon.pyodide_url]\n```\n\n## Learn more\n\n\u26a0\ufe0f The documentation for advanced configuration is available from the main JupyterLite\ndocumentation site:\n\n- [configuring]\n- [command line interface][cli]\n\n[configuring]:\n https://jupyterlite.readthedocs.io/en/latest/howto/index.html#configuring-the-python-environment\n[cli]: https://jupyterlite.readthedocs.io/en/latest/reference/cli.html\n\n## Uninstall\n\nTo remove the extension, run:\n\n```bash\npip uninstall jupyterlite-pyodide-kernel # or however you installed it\n```\n\n## Prerelease Versions\n\nTo install pre-release versions with `pip`:\n\n```bash\npip install --upgrade --pre jupyterlite-pyodide-kernel\n```\n\nOr, similarly for the `conda` ecosystem, for `alpha` packages:\n\n```bash\nconda install \\\n -c conda-forge/label/jupyterlite_core_alpha \\\n -c conda-forge/label/jupyterlite_pyodide_kernel_alpha \\\n -c conda-forge \\\n jupyterlite-pyodide-kernel\n```\n\n> Note: `_beta` and `_rc` packages would follow a similar channel naming convention\n\n## Development Install\n\nBelow is an short overview of getting up and running quickly. Please see the\n[contributing guide][contrib] for full details.\n\n### Development Requirements\n\n**Recommended** a Python virtual environment provided by a tool of choice, e.g. one of:\n\n- `virtualenv`\n- `mamba`\n- `conda`\n\nEnsure the local development environment has:\n\n- `git`\n- `nodejs 20`\n- `python >=3.8`\n\n### Development Quick Start\n\n```bash\ngit clone https://github.com/jupyterlite/pyodide-kernel\ncd pyodide-kernel\nnpm run quickstart\n```\n\nThen, serve the built demo site, documentation, and test reports with Python's built-in\nHTTP server:\n\n```bash\njlpm serve\n```\n\n[contrib]: https://github.com/jupyterlite/pyodide-kernel/blob/main/CONTRIBUTING.md\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c), 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": "Python kernel for JupyterLite powered by Pyodide",
"version": "0.3.1",
"project_urls": {
"Documentation": "https://jupyterlite-pyodide-kernel.readthedocs.io",
"Homepage": "https://jupyterlite-pyodide-kernel.readthedocs.io",
"Issues": "https://github.com/jupyterlite/pyodide-kernel/issues",
"PyPI": "https://pypi.org/project/jupyterlite-pyodide-kernel",
"Source": "https://github.com/jupyterlite/pyodide-kernel"
},
"split_keywords": [
"browser",
" jupyter",
" jupyterlab",
" jupyterlite",
" notebook",
" pyodide"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83bf749279904094015d5cb7e030dd7a111f8b013b9f1809d954d04ebe0c1197",
"md5": "822fe8207020ce995a794f7e9cbada2a",
"sha256": "ac9d9dd95adcced57d465a7b298f220d8785845c017ad3abf2a3677ff02631c6"
},
"downloads": -1,
"filename": "jupyterlite_pyodide_kernel-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "822fe8207020ce995a794f7e9cbada2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 211967,
"upload_time": "2024-03-30T13:52:57",
"upload_time_iso_8601": "2024-03-30T13:52:57.277842Z",
"url": "https://files.pythonhosted.org/packages/83/bf/749279904094015d5cb7e030dd7a111f8b013b9f1809d954d04ebe0c1197/jupyterlite_pyodide_kernel-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "05c8cadab766854b2a728ad8376078cc297977fc577213cb587ada448aea4e44",
"md5": "4155c324eb0abc22f06cfbffb7eaf1e4",
"sha256": "cff663cfed4e6319bd3256f09e02d450f94917ba3704d9178d69146bb3467801"
},
"downloads": -1,
"filename": "jupyterlite_pyodide_kernel-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "4155c324eb0abc22f06cfbffb7eaf1e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 197281,
"upload_time": "2024-03-30T13:52:59",
"upload_time_iso_8601": "2024-03-30T13:52:59.348372Z",
"url": "https://files.pythonhosted.org/packages/05/c8/cadab766854b2a728ad8376078cc297977fc577213cb587ada448aea4e44/jupyterlite_pyodide_kernel-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 13:52:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlite",
"github_project": "pyodide-kernel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlite-pyodide-kernel"
}
