| Name | jupyterlab-rise JSON |
| Version |
0.43.1
JSON |
| download |
| home_page | None |
| Summary | RISE: "Live" Reveal.js JupyterLab Slideshow extension. |
| upload_time | 2024-12-31 09:34:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2022, Frederic Collonval 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 |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab_rise
[](https://jupyterlab-contrib.github.io/index.html) [](https://github.com/jupyterlab-contrib/rise/actions/workflows/build.yml) [](https://mybinder.org/v2/gh/jupyterlab-contrib/rise/main?urlpath=lab/tree/examples/README.ipynb) [](https://pypi.org/project/jupyterlab-rise/)
RISE: "Live" Reveal.js JupyterLab Slideshow extension.
## Requirements
- JupyterLab >= 4.1.2
## Install
To install the extension with pip, execute:
```bash
pip install jupyterlab_rise
```
For conda, execute:
```bash
conda install conda-forge::jupyterlab_rise
```
For JupyterLab 3.x, install version prior to 0.40.0:
```bash
pip install "jupyterlab_rise<0.40.0"
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyterlab_rise
```
## Usage
To mark a cell as a new slide, sub-slide or fragment, open the property inspector and choose the slide type:
<img src="./docs/prop-inspector-slide-type.png" alt="Property inspector slide type" style="width:100%; height:auto;">
Use `Ctrl+R` to render the current notebook as a slidehow:
<img src="./docs/render-slideshow.png" alt="Rendered slideshow" style="width:100%; height:auto;">
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:
```bash
jupyter labextension list
```
## 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_rise directory
# Install package in development mode
pip install -e ".[test]"
jlpm install
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable jupyterlab_rise
# 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
# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_rise
pip uninstall jupyterlab_rise
```
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 `jupyterlab-rise` 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": "jupyterlab-rise",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Frederic Collonval <fcollonval@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/e4/5d94cfdb93a6f0f9707a5d988b294e4c62d7944e0c77dba3e1a6a3389521/jupyterlab_rise-0.43.1.tar.gz",
"platform": null,
"description": "# jupyterlab_rise\n\n[](https://jupyterlab-contrib.github.io/index.html) [](https://github.com/jupyterlab-contrib/rise/actions/workflows/build.yml) [](https://mybinder.org/v2/gh/jupyterlab-contrib/rise/main?urlpath=lab/tree/examples/README.ipynb) [](https://pypi.org/project/jupyterlab-rise/)\n\nRISE: \"Live\" Reveal.js JupyterLab Slideshow extension.\n\n## Requirements\n\n- JupyterLab >= 4.1.2\n\n## Install\n\nTo install the extension with pip, execute:\n\n```bash\npip install jupyterlab_rise\n```\n\nFor conda, execute:\n\n```bash\nconda install conda-forge::jupyterlab_rise\n```\n\nFor JupyterLab 3.x, install version prior to 0.40.0:\n\n```bash\npip install \"jupyterlab_rise<0.40.0\"\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab_rise\n```\n\n## Usage\n\nTo mark a cell as a new slide, sub-slide or fragment, open the property inspector and choose the slide type:\n\n<img src=\"./docs/prop-inspector-slide-type.png\" alt=\"Property inspector slide type\" style=\"width:100%; height:auto;\">\n\nUse `Ctrl+R` to render the current notebook as a slidehow:\n\n<img src=\"./docs/render-slideshow.png\" alt=\"Rendered slideshow\" style=\"width:100%; height:auto;\">\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\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_rise directory\n# Install package in development mode\npip install -e \".[test]\"\njlpm install\njlpm build\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable jupyterlab_rise\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\n# Server extension must be manually disabled in develop mode\njupyter server extension disable jupyterlab_rise\npip uninstall jupyterlab_rise\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 `jupyterlab-rise` 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": "BSD 3-Clause License Copyright (c) 2022, Frederic Collonval 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": "RISE: \"Live\" Reveal.js JupyterLab Slideshow extension.",
"version": "0.43.1",
"project_urls": {
"Bug Tracker": "https://github.com/jupyterlab-contrib/rise/issues",
"Homepage": "https://github.com/jupyterlab-contrib/rise",
"Repository": "https://github.com/jupyterlab-contrib/rise.git"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d6bccc3f8d9940719b1d6c0c12aab9417d4008ff6aa419c8d103aa4c29ee3d1",
"md5": "6ccb234675081ebd91bcfdaae609a757",
"sha256": "62ba6d8c07a80dff293589512d57901029800a23a860904b14eb96d597cb8573"
},
"downloads": -1,
"filename": "jupyterlab_rise-0.43.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ccb234675081ebd91bcfdaae609a757",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16418327,
"upload_time": "2024-12-31T09:34:41",
"upload_time_iso_8601": "2024-12-31T09:34:41.403872Z",
"url": "https://files.pythonhosted.org/packages/5d/6b/ccc3f8d9940719b1d6c0c12aab9417d4008ff6aa419c8d103aa4c29ee3d1/jupyterlab_rise-0.43.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3e45d94cfdb93a6f0f9707a5d988b294e4c62d7944e0c77dba3e1a6a3389521",
"md5": "e23a38536457b6cfe38d72af2ebe1f55",
"sha256": "264ec00e2cb5cc68e2042a054eea2d42925f47f36d883eba9c475b6dd2fe87d3"
},
"downloads": -1,
"filename": "jupyterlab_rise-0.43.1.tar.gz",
"has_sig": false,
"md5_digest": "e23a38536457b6cfe38d72af2ebe1f55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 31528296,
"upload_time": "2024-12-31T09:34:47",
"upload_time_iso_8601": "2024-12-31T09:34:47.349868Z",
"url": "https://files.pythonhosted.org/packages/d3/e4/5d94cfdb93a6f0f9707a5d988b294e4c62d7944e0c77dba3e1a6a3389521/jupyterlab_rise-0.43.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-31 09:34:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab-contrib",
"github_project": "rise",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-rise"
}
