| Name | jupyterlab-cell-flash JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | JupyterLab extension to show a flash effect when a cell is executed |
| upload_time | 2023-11-21 15:52:34 |
| maintainer | |
| docs_url | None |
| author | JupyterLab Contrib Team |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2021, JupyterLab Contrib Team Copyright (c) 2020, Jeremy Tuloup All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * 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.
|
# jupyterlab-cell-flash
[](https://jupyterlab-contrib.github.io/)
[](https://github.com/jupyterlab-contrib/jupyterlab-cell-flash/actions/workflows/build.yml)
[](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-cell-flash/main?urlpath=/lab/tree/demo.ipynb)
[](https://pypi.org/project/jupyterlab-cell-flash)
[](https://www.npmjs.com/package/jupyterlab-cell-flash)
JupyterLab extension to show a flash effect when a cell is executed.
## Requirements
- JupyterLab >= 2.0
## Install
For JupyterLab 3.x, the extension can be installed with `pip`:
```bash
pip install jupyterlab-cell-flash
```
For JupyterLab 1.x and 2.x:
```bash
jupyter labextension install jupyterlab-cell-flash
```
## Settings
Use the following settings to tweak the color and the duration of the animation (in `Settings > Advanced Settings Editor`):
```json5
{
// The base color for the flash effect
color: 'rgba(255, 255, 0, 0.5)',
// The duration of the flash effect animation (in seconds)
duration: 0.5
}
```
## 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 jupyterlab-cell-flash directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jlpm run install:extension
# 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).
### Uninstall
```bash
pip uninstall jupyterlab-cell-flash
jupyter labextension uninstall jupyterlab-cell-flash
```
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterlab-cell-flash",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "JupyterLab Contrib Team",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d7/0b/28276da51d57f93744b5762af3a2608fa4bca6c047fc0876fe066759d79e/jupyterlab_cell_flash-0.4.0.tar.gz",
"platform": null,
"description": "# jupyterlab-cell-flash\n\n[](https://jupyterlab-contrib.github.io/)\n[](https://github.com/jupyterlab-contrib/jupyterlab-cell-flash/actions/workflows/build.yml)\n[](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-cell-flash/main?urlpath=/lab/tree/demo.ipynb)\n[](https://pypi.org/project/jupyterlab-cell-flash)\n[](https://www.npmjs.com/package/jupyterlab-cell-flash)\n\nJupyterLab extension to show a flash effect when a cell is executed.\n\n## Requirements\n\n- JupyterLab >= 2.0\n\n## Install\n\nFor JupyterLab 3.x, the extension can be installed with `pip`:\n\n```bash\npip install jupyterlab-cell-flash\n```\n\nFor JupyterLab 1.x and 2.x:\n\n```bash\njupyter labextension install jupyterlab-cell-flash\n```\n\n## Settings\n\nUse the following settings to tweak the color and the duration of the animation (in `Settings > Advanced Settings Editor`):\n\n```json5\n{\n // The base color for the flash effect\n color: 'rgba(255, 255, 0, 0.5)',\n\n // The duration of the flash effect animation (in seconds)\n duration: 0.5\n}\n```\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 jupyterlab-cell-flash directory\n# Install package in development mode\npip install -e .\n# Link your development version of the extension with JupyterLab\njlpm run install:extension\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### Uninstall\n\n```bash\npip uninstall jupyterlab-cell-flash\njupyter labextension uninstall jupyterlab-cell-flash\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2021, JupyterLab Contrib Team Copyright (c) 2020, Jeremy Tuloup All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * 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. * 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": "JupyterLab extension to show a flash effect when a cell is executed",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlab-contrib/jupyterlab-cell-flash/issues",
"Homepage": "https://github.com/jupyterlab-contrib/jupyterlab-cell-flash",
"Repository": "https://github.com/jupyterlab-contrib/jupyterlab-cell-flash.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "caebdd9cb73fa6c53258b0470ad6c7c19bcb44d4793ee0c3140199f5bff7288e",
"md5": "76b6f5ac00a9bdefb53cafec97dce00d",
"sha256": "0cc60fcb95ba079dc9f39376f9ec1c526ac9bcefe544cf04c29f204a96da3e82"
},
"downloads": -1,
"filename": "jupyterlab_cell_flash-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76b6f5ac00a9bdefb53cafec97dce00d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18409,
"upload_time": "2023-11-21T15:52:32",
"upload_time_iso_8601": "2023-11-21T15:52:32.477738Z",
"url": "https://files.pythonhosted.org/packages/ca/eb/dd9cb73fa6c53258b0470ad6c7c19bcb44d4793ee0c3140199f5bff7288e/jupyterlab_cell_flash-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d70b28276da51d57f93744b5762af3a2608fa4bca6c047fc0876fe066759d79e",
"md5": "d879f2904944a124c7adb8153806648a",
"sha256": "f3768b8c62f7e8a732e52c71d709e6313771374d9ab4d16d37d67c38547d1789"
},
"downloads": -1,
"filename": "jupyterlab_cell_flash-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "d879f2904944a124c7adb8153806648a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 252976,
"upload_time": "2023-11-21T15:52:34",
"upload_time_iso_8601": "2023-11-21T15:52:34.462470Z",
"url": "https://files.pythonhosted.org/packages/d7/0b/28276da51d57f93744b5762af3a2608fa4bca6c047fc0876fe066759d79e/jupyterlab_cell_flash-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 15:52:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab-contrib",
"github_project": "jupyterlab-cell-flash",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-cell-flash"
}
