| Name | sidecar JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | |
| Summary | A sidecar output widget for JupyterLab |
| upload_time | 2023-08-30 15:33:29 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2023, Project Jupyter 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# Sidecar
[](https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar)
[](https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar)
A sidecar output widget for JupyterLab
## Installation
```bash
pip install sidecar
```
or
```bash
conda install sidecar
```
If you use JupyterLab <=2:
```bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install @jupyter-widgets/jupyterlab-sidecar
```
## Usage
The sidecar widget is used as a context manager, just like ipywidgets' output
widget.
```python
from sidecar import Sidecar
from ipywidgets import IntSlider
sc = Sidecar(title='Sidecar Output')
sl = IntSlider(description='Some slider')
with sc:
display(sl)
```
When a single output is displayed in a Sidecar, it is allowed to occupy all of
the vertical space available. If more content is displayed, the natural height
is used instead.
## Development
```bash
# Create a new conda environment
conda create -n jupyterlab-sidecar -c conda-forge jupyterlab ipywidgets nodejs -y
# Activate the conda environment
conda activate jupyterlab-sidecar
# 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 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).
By default, the jlpm run 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
```
## Uninstall
```bash
pip uninstall sidecar
```
or
```bash
conda uninstall sidecar
```
Raw data
{
"_id": null,
"home_page": "",
"name": "sidecar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Project Jupyter <ipython-dev@scipy.org>",
"download_url": "https://files.pythonhosted.org/packages/23/8c/1143344be27a8c72ab8f02e6b55270e89eca6387bae542f958b056a18764/sidecar-0.7.0.tar.gz",
"platform": null,
"description": "# Sidecar\n\n[](https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar)\n[](https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar)\n\nA sidecar output widget for JupyterLab\n\n## Installation\n\n```bash\npip install sidecar\n```\n\nor\n\n```bash\nconda install sidecar\n```\n\nIf you use JupyterLab <=2:\n\n```bash\njupyter labextension install @jupyter-widgets/jupyterlab-manager\njupyter labextension install @jupyter-widgets/jupyterlab-sidecar\n```\n\n## Usage\n\nThe sidecar widget is used as a context manager, just like ipywidgets' output\nwidget.\n\n```python\nfrom sidecar import Sidecar\nfrom ipywidgets import IntSlider\n\nsc = Sidecar(title='Sidecar Output')\nsl = IntSlider(description='Some slider')\nwith sc:\n display(sl)\n```\n\nWhen a single output is displayed in a Sidecar, it is allowed to occupy all of\nthe vertical space available. If more content is displayed, the natural height\nis used instead.\n\n\n\n## Development\n\n```bash\n# Create a new conda environment\nconda create -n jupyterlab-sidecar -c conda-forge jupyterlab ipywidgets nodejs -y\n\n# Activate the conda environment\nconda activate jupyterlab-sidecar\n\n# Install package in development mode\npip install -e .\n\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n\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\nBy default, the jlpm run 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## Uninstall\n\n```bash\npip uninstall sidecar\n```\n\nor\n\n```bash\nconda uninstall sidecar\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, Project Jupyter 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": "A sidecar output widget for JupyterLab",
"version": "0.7.0",
"project_urls": {
"Bug Tracker": "https://github.com/jupyter-widgets/jupyterlab-sidecar/issues",
"Homepage": "https://github.com/jupyter-widgets/jupyterlab-sidecar",
"Repository": "https://github.com/jupyter-widgets/jupyterlab-sidecar"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c58e3a325661f42c7d7aa246b16cbf1113caf94d418e5c367a2483ee1e1f9603",
"md5": "68112a5d1e8e84867edee3f972aafdd9",
"sha256": "a18e5972b45f5b6a81d6738a223471b3e1627bff1e26053834fd843006e67446"
},
"downloads": -1,
"filename": "sidecar-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68112a5d1e8e84867edee3f972aafdd9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17821,
"upload_time": "2023-08-30T15:33:27",
"upload_time_iso_8601": "2023-08-30T15:33:27.070871Z",
"url": "https://files.pythonhosted.org/packages/c5/8e/3a325661f42c7d7aa246b16cbf1113caf94d418e5c367a2483ee1e1f9603/sidecar-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "238c1143344be27a8c72ab8f02e6b55270e89eca6387bae542f958b056a18764",
"md5": "5f78c8b961774516c3cf405c87d261e7",
"sha256": "c3fa1694b5611c1fab9d7a96c07577ba0764068a89b7b39be9b9ce9770e9d363"
},
"downloads": -1,
"filename": "sidecar-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "5f78c8b961774516c3cf405c87d261e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3333537,
"upload_time": "2023-08-30T15:33:29",
"upload_time_iso_8601": "2023-08-30T15:33:29.080175Z",
"url": "https://files.pythonhosted.org/packages/23/8c/1143344be27a8c72ab8f02e6b55270e89eca6387bae542f958b056a18764/sidecar-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 15:33:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyter-widgets",
"github_project": "jupyterlab-sidecar",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "sidecar"
}
