| Name | jupyter-iframe-commands JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension to facilitate integration with a host page via an IFrame |
| upload_time | 2024-12-10 07:45:27 |
| maintainer | None |
| docs_url | None |
| author | QuantStack |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 TileDB, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
jupyterlite-core
jupyterlite-pyodide-kernel
jupyterlab
notebook
jupyterlab-night
jupyterlab_miami_nights
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyter-iframe-commands
[](https://github.com/TileDB-Inc/jupyter-iframe-commands/actions/workflows/build.yml)
A JupyterLab extension to facilitate integration with a host page via an IFrame
> [!WARNING]
> This project is still in an early development stage.
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension
- Clone the repo to your local environment
- Change directory to the `jupyter-iframe-commands` directory
- execute: `pip install .`
## Usage
Try out a preview [here](https://tiledb-inc.github.io/jupyter-iframe-commands/)
### Available Commands
> [!NOTE]
> The list of available commands may depend on:
>
> - The JupyterLab version
> - Whether your JupyterLab configuration disables some core plugins or extensions
> - Third-party extensions available in the JupyterLab environment
Some examples of available commands:
- `application:toggle-left-area`
- `apputils:activate-command-palette`
- `apputils:display-shortcuts`
- `extensionmanager:show-panel`
- `notebook:create-new`
- `notebook:insert-cell-below`
Examples of commands with arguments:
- `apputils:change-theme` `{ 'theme': 'JupyterLab Dark' }`
- `settingeditor:open` `{ 'settingEditorType': 'json' }`
> [!TIP]
> For reference JupyterLab defines a list of default commands here: https://jupyterlab.readthedocs.io/en/latest/user/commands.html#commands-list
## Demos
### Local Demo
To run the demo on a local Jupyter Lab instance:
- Follow the [development install instructions](#development-install)
- `cd demo`
- Run: `jlpm start:lab`
- In another terminal
- Run: `jlpm start:local`
Open http://localhost:8080 in your browser.
### Lite Demo
To run the demo on a Jupyter Lite instance:
- Follow the [development install instructions](#development-install)
- Run: `jlpm build:lite`
- `cd demo`
- Run: `jlpm start:lite`
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyter-iframe-commands
```
## 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 jupyter-iframe-commands directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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 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).
By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
pip uninstall jupyter-iframe-commands
```
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 `jupyter-iframe-commands` within that folder.
### Testing the extension
#### Integration tests
This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
More information are provided within the [ui-tests](./ui-tests/README.md) README.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyter-iframe-commands",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": "QuantStack",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9e/1e/febfe3d40bb138b2dd7556908ee54279005f6178c863e87d7f82778f9a28/jupyter_iframe_commands-0.0.1.tar.gz",
"platform": null,
"description": "# jupyter-iframe-commands\n\n[](https://github.com/TileDB-Inc/jupyter-iframe-commands/actions/workflows/build.yml)\n\nA JupyterLab extension to facilitate integration with a host page via an IFrame\n\n> [!WARNING]\n> This project is still in an early development stage.\n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension\n\n- Clone the repo to your local environment\n- Change directory to the `jupyter-iframe-commands` directory\n- execute: `pip install .`\n\n## Usage\n\nTry out a preview [here](https://tiledb-inc.github.io/jupyter-iframe-commands/)\n\n### Available Commands\n\n> [!NOTE]\n> The list of available commands may depend on:\n>\n> - The JupyterLab version\n> - Whether your JupyterLab configuration disables some core plugins or extensions\n> - Third-party extensions available in the JupyterLab environment\n\nSome examples of available commands:\n\n- `application:toggle-left-area`\n- `apputils:activate-command-palette`\n- `apputils:display-shortcuts`\n- `extensionmanager:show-panel`\n- `notebook:create-new`\n- `notebook:insert-cell-below`\n\nExamples of commands with arguments:\n\n- `apputils:change-theme` `{ 'theme': 'JupyterLab Dark' }`\n- `settingeditor:open` `{ 'settingEditorType': 'json' }`\n\n> [!TIP]\n> For reference JupyterLab defines a list of default commands here: https://jupyterlab.readthedocs.io/en/latest/user/commands.html#commands-list\n\n## Demos\n\n### Local Demo\n\nTo run the demo on a local Jupyter Lab instance:\n\n- Follow the [development install instructions](#development-install)\n- `cd demo`\n- Run: `jlpm start:lab`\n- In another terminal\n- Run: `jlpm start:local`\n\nOpen http://localhost:8080 in your browser.\n\n### Lite Demo\n\nTo run the demo on a Jupyter Lite instance:\n\n- Follow the [development install instructions](#development-install)\n- Run: `jlpm build:lite`\n- `cd demo`\n- Run: `jlpm start:lite`\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyter-iframe-commands\n```\n\n## Contributing\n\n### Development install\n\n> [!NOTE]\n> 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 jupyter-iframe-commands directory\n# Install package in development mode\npip install -e \".\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Rebuild extension Typescript source after making changes\njlpm 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 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\nBy default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\npip uninstall jupyter-iframe-commands\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 `jupyter-iframe-commands` within that folder.\n\n### Testing the extension\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 TileDB, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A JupyterLab extension to facilitate integration with a host page via an IFrame",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/TileDB-Inc/jupyter-iframe-commands/issues",
"Homepage": "https://github.com/TileDB-Inc/jupyter-iframe-commands"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "901178e90987fb02f12281288cdc9924836e284e8b5fd87697aa30f8e9b2ad49",
"md5": "9b3a0cf70bba72b8e0346a49eeb27a83",
"sha256": "595cb71bee16a5c60d64a6f60d716ea3dcf4322b7d3a791ce7c3248cdff452c9"
},
"downloads": -1,
"filename": "jupyter_iframe_commands-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b3a0cf70bba72b8e0346a49eeb27a83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19906,
"upload_time": "2024-12-10T07:45:23",
"upload_time_iso_8601": "2024-12-10T07:45:23.062568Z",
"url": "https://files.pythonhosted.org/packages/90/11/78e90987fb02f12281288cdc9924836e284e8b5fd87697aa30f8e9b2ad49/jupyter_iframe_commands-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e1efebfe3d40bb138b2dd7556908ee54279005f6178c863e87d7f82778f9a28",
"md5": "4a96543fcd818eb1b0ed582f46c05b5f",
"sha256": "fdc472619e6cfdce5f920abe5a74c2457cb8698adc5388b86a3959f10fd0ef2c"
},
"downloads": -1,
"filename": "jupyter_iframe_commands-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4a96543fcd818eb1b0ed582f46c05b5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 267869,
"upload_time": "2024-12-10T07:45:27",
"upload_time_iso_8601": "2024-12-10T07:45:27.825248Z",
"url": "https://files.pythonhosted.org/packages/9e/1e/febfe3d40bb138b2dd7556908ee54279005f6178c863e87d7f82778f9a28/jupyter_iframe_commands-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 07:45:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TileDB-Inc",
"github_project": "jupyter-iframe-commands",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jupyterlite-core",
"specs": [
[
"==",
"0.4.4"
]
]
},
{
"name": "jupyterlite-pyodide-kernel",
"specs": [
[
"==",
"0.4.4"
]
]
},
{
"name": "jupyterlab",
"specs": [
[
"~=",
"4.3"
]
]
},
{
"name": "notebook",
"specs": [
[
"~=",
"7.3"
]
]
},
{
"name": "jupyterlab-night",
"specs": []
},
{
"name": "jupyterlab_miami_nights",
"specs": []
}
],
"lcname": "jupyter-iframe-commands"
}
