# Quibbler's Jupyterlab extension
Integrate Quibbler's Undo/Redo and Save/Load capabilities within JupyterLab.
For a complete guide to using Quibbler within JupyterLab, see [here](https://quibbler.readthedocs.io/en/latest/Jupyter-lab-ext.html).
## Undo / Redo
The extension adds **Undo/Redo** buttons to the JupyterLab toolbar.
Here is and example of how these buttons behave
(with the
[image thresholding demo](https://quibbler.readthedocs.io/en/latest/examples/quibdemo_image_thresholding.html)):
## Save / Load
<img src="https://github.com/Technion-Kishony-lab/quibbler/blob/master/pyquibbler-documentations/docs/images/labext_quibbler_menu.png?raw=true" width=250 align='right'>
Assignments to quibs can be saved into the JupyterLab's notebook,
allowing restoring prior values both within the session and when
restarting the notebook as a new session. To enable saving quib assignments into the notebook
check the “Save/Load inside Notebook” option in the JupyterLab
*Quibbler* menu.
Once enabled, quib assignments can easily be saved/loaded, either
globally for the entire notebook by choosing **Save/Load** from the JupyterLab's
**Quibbler** menu, or
individually by clicking the Save/Load buttons at the bottom of the Quib
Editor of the relevant quib, as shown here:
## Requirements
* JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install pyquibbler_labextension
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall pyquibbler_labextension
```
## 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 pyquibbler_labextension 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 pyquibbler_labextension
```
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 `pyquibbler-labextension` within that folder.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/Technion-Kishony-lab/quibbler",
"name": "pyquibbler-labextension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Jupyter, JupyterLab, JupyterLab3",
"author": null,
"author_email": null,
"download_url": null,
"platform": "Linux",
"description": "# Quibbler's Jupyterlab extension\n\n\n\n\n\nIntegrate Quibbler's Undo/Redo and Save/Load capabilities within JupyterLab.\n\n\n\nFor a complete guide to using Quibbler within JupyterLab, see [here](https://quibbler.readthedocs.io/en/latest/Jupyter-lab-ext.html).\n\n## Undo / Redo\n\nThe extension adds **Undo/Redo** buttons to the JupyterLab toolbar.\n\nHere is and example of how these buttons behave \n(with the\n[image thresholding demo](https://quibbler.readthedocs.io/en/latest/examples/quibdemo_image_thresholding.html)):\n\n\n\n\n## Save / Load\n<img src=\"https://github.com/Technion-Kishony-lab/quibbler/blob/master/pyquibbler-documentations/docs/images/labext_quibbler_menu.png?raw=true\" width=250 align='right'>\n\nAssignments to quibs can be saved into the JupyterLab's notebook,\nallowing restoring prior values both within the session and when\nrestarting the notebook as a new session. To enable saving quib assignments into the notebook\ncheck the \u201cSave/Load inside Notebook\u201d option in the JupyterLab\n*Quibbler* menu.\n\nOnce enabled, quib assignments can easily be saved/loaded, either\nglobally for the entire notebook by choosing **Save/Load** from the JupyterLab's\n**Quibbler** menu, or\nindividually by clicking the Save/Load buttons at the bottom of the Quib\nEditor of the relevant quib, as shown here:\n\n\n\n\n## Requirements\n\n* JupyterLab >= 3.0\n\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install pyquibbler_labextension\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall pyquibbler_labextension\n```\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 pyquibbler_labextension 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 pyquibbler_labextension\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 `pyquibbler-labextension` within that folder.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": null,
"summary": "PyQuibbler lab extension",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/Technion-Kishony-lab/quibbler"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "010797cd5f76f431e8e4deb1083f640652c85d0814f9ac18084860f95efe85f4",
"md5": "abbe28c156d98843865c48da6e7d20b0",
"sha256": "3edf2b6a8cd6086efadd7df604ac334077d4b8110243501fbb6e4d56fb1fbd1d"
},
"downloads": -1,
"filename": "pyquibbler_labextension-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "abbe28c156d98843865c48da6e7d20b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 88851,
"upload_time": "2024-08-03T21:55:06",
"upload_time_iso_8601": "2024-08-03T21:55:06.667998Z",
"url": "https://files.pythonhosted.org/packages/01/07/97cd5f76f431e8e4deb1083f640652c85d0814f9ac18084860f95efe85f4/pyquibbler_labextension-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-03 21:55:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Technion-Kishony-lab",
"github_project": "quibbler",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pyquibbler-labextension"
}
JSON
