# SwanHelp
Help panel for SWAN
This extension adds the following to the 'Help' menu in the menubar
- About dialog
- Links to Community Forum, and Support portal
- A help panel that opens an iframe to the documentation website
- An 'Examples Gallery' panel that opens the notebook gallery website inside an iframe. The extension
also allows downloading and opening notebooks in the gallery website directly inside the SWAN session.
This extension is composed of a Python package named `swanhelp`, which installs the nbextension and a NPM package named `@swan-cern/swanhelp`
for the JupyterLab extension.
## How the 'Examples Gallery' works
- The gallery panel allows browsing the SWAN Gallery website within an iframe and downloading notebooks into the
SWAN session all from within the JupyterLab UI.
- On clicking download inside the iframe, javascript inside the iframe sends a message using `window.postMessage()` to the
parent JupyterLab window.
- The JupyterLab extension handles this message and makes a request to the SwanContents API (`/user/api/contents/download`) with the URL
of the notebook to download.
- The jupyter server downloads the notebook and on success the notebook is opened by the extension in a new tab in JupyterLab
## Requirements
- JupyterLab >= 4.0.0
## Install
To install the extension, execute:
```bash
pip install swanhelp
```
To enable the nbextension in the classic notebook ui (now renamed nbclassic):
```bash
jupyter nbclassic-extension install swanhelp --py
jupyter nbclassic-extension enable swanhelp --py
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall swanhelp
```
## 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 swanhelp 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 swanhelp
```
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 `@swan-cern/swanhelp` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/swan-cern/jupyter-extensions.git",
"name": "swanhelp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3,SWAN,CERN",
"author": "SWAN Admins",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e5/21/df32ce3aacf52b82866687049001d0d13148893433b3afc97ec4f529c421/swanhelp-3.0.2.tar.gz",
"platform": "Linux",
"description": "# SwanHelp\n\nHelp panel for SWAN\n\nThis extension adds the following to the 'Help' menu in the menubar\n- About dialog \n- Links to Community Forum, and Support portal\n- A help panel that opens an iframe to the documentation website\n- An 'Examples Gallery' panel that opens the notebook gallery website inside an iframe. The extension \n also allows downloading and opening notebooks in the gallery website directly inside the SWAN session.\n\nThis extension is composed of a Python package named `swanhelp`, which installs the nbextension and a NPM package named `@swan-cern/swanhelp`\nfor the JupyterLab extension.\n\n## How the 'Examples Gallery' works\n\n- The gallery panel allows browsing the SWAN Gallery website within an iframe and downloading notebooks into the \nSWAN session all from within the JupyterLab UI.\n\n- On clicking download inside the iframe, javascript inside the iframe sends a message using `window.postMessage()` to the \nparent JupyterLab window.\n\n- The JupyterLab extension handles this message and makes a request to the SwanContents API (`/user/api/contents/download`) with the URL \nof the notebook to download.\n\n- The jupyter server downloads the notebook and on success the notebook is opened by the extension in a new tab in JupyterLab \n\n## Requirements\n\n- JupyterLab >= 4.0.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install swanhelp\n```\n\nTo enable the nbextension in the classic notebook ui (now renamed nbclassic):\n```bash\njupyter nbclassic-extension install swanhelp --py\njupyter nbclassic-extension enable swanhelp --py\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall swanhelp\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 swanhelp 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 swanhelp\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 `@swan-cern/swanhelp` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Help panel for SWAN",
"version": "3.0.2",
"project_urls": {
"Homepage": "https://github.com/swan-cern/jupyter-extensions.git"
},
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3",
"swan",
"cern"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f6780c855cdc7e7696288b7afb0822bb7826ac819e54b7aa079823c594ef89e",
"md5": "ed951e7bfafb29bb07a5da90902ae6c7",
"sha256": "81ad04014db97ca6ecaf0144792481938a94999d227632fc7a5a3aaeb04b5cf3"
},
"downloads": -1,
"filename": "swanhelp-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed951e7bfafb29bb07a5da90902ae6c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 88625,
"upload_time": "2023-11-27T18:00:41",
"upload_time_iso_8601": "2023-11-27T18:00:41.250327Z",
"url": "https://files.pythonhosted.org/packages/4f/67/80c855cdc7e7696288b7afb0822bb7826ac819e54b7aa079823c594ef89e/swanhelp-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e521df32ce3aacf52b82866687049001d0d13148893433b3afc97ec4f529c421",
"md5": "78636b97f848ad8c349b3cb3bd1d2382",
"sha256": "6363fcc3e53591b17b5f2860415fb95c2e5f0788b2e1d22b26012ebe8305de45"
},
"downloads": -1,
"filename": "swanhelp-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "78636b97f848ad8c349b3cb3bd1d2382",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 152690,
"upload_time": "2023-11-27T18:00:42",
"upload_time_iso_8601": "2023-11-27T18:00:42.681849Z",
"url": "https://files.pythonhosted.org/packages/e5/21/df32ce3aacf52b82866687049001d0d13148893433b3afc97ec4f529c421/swanhelp-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 18:00:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "swan-cern",
"github_project": "jupyter-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "swanhelp"
}
JSON
