# jupyter_bokeh
A Jupyter extension for rendering [Bokeh](https://bokeh.org) content within Jupyter. See also the separate [ipywidgets_bokeh](https://github.com/bokeh/ipywidgets_bokeh) library for support for using Jupyter widgets/ipywidgets objects within Bokeh applications.
## Install
For versions 3.0 and newer of JupyterLab, you have the option to install
jupyter_bokeh with either ``pip`` or ``conda``:
```bash
pip install jupyter_bokeh
```
or
```bash
conda install -c conda-forge jupyter_bokeh
```
For versions of Jupyter Lab older than 3.0, you must install the labextension
separately:
```bash
conda install -c conda-forge jupyter_bokeh
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install @bokeh/jupyter_bokeh
```
To install a specific version:
```bash
jupyter labextension install @bokeh/jupyter_bokeh@x.y.x
```
## Compatibility
The core [Bokeh](https://github.com/bokeh/bokeh) library is generally version independent of
[JupyterLab](https://github.com/jupyterlab/jupyterlab) and this ``jupyter_bokeh`` extension
for versions of ``bokeh>=2.0.0``.
Our goal is that ``jupyter_bokeh`` minor releases (using the [SemVer](https://semver.org/) pattern) are
made to follow JupyterLab minor release bumps, while micro releases are for new ``jupyter_bokeh`` features
or bug fix releases. We've been previously inconsistent with having the extension release minor version bumps
track that of JupyterLab, so users seeking to find extension releases that are compatible with their JupyterLab
installation may refer to the below table.
###### Compatible JupyterLab and `jupyter_bokeh` versions
| JupyterLab | `jupyter_bokeh` |
| ------------- | ---------------- |
| 0.34.x | 0.6.2 |
| 0.35.x | 0.6.3 |
| 1.0.x | 1.0.0 |
| 2.0.x | 2.0.0 |
| 3.0.x | 3.0.0 |
## 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 jupyter_bokeh 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 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 jupyter_bokeh
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bokeh/jupyter_bokeh",
"name": "jupyter-bokeh",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Bokeh team",
"author_email": "info@bokeh.org",
"download_url": "https://files.pythonhosted.org/packages/98/90/461fa635cca3b7f76fb87786c8b96bb172192b16e12e1db60b0fcdb99ca9/jupyter_bokeh-3.0.5.tar.gz",
"platform": "Linux",
"description": "# jupyter_bokeh\n\n\n\nA Jupyter extension for rendering [Bokeh](https://bokeh.org) content within Jupyter. See also the separate [ipywidgets_bokeh](https://github.com/bokeh/ipywidgets_bokeh) library for support for using Jupyter widgets/ipywidgets objects within Bokeh applications.\n\n\n## Install\n\nFor versions 3.0 and newer of JupyterLab, you have the option to install\njupyter_bokeh with either ``pip`` or ``conda``:\n\n```bash\npip install jupyter_bokeh\n```\n\nor\n\n```bash\nconda install -c conda-forge jupyter_bokeh\n```\n\nFor versions of Jupyter Lab older than 3.0, you must install the labextension\nseparately:\n\n```bash\nconda install -c conda-forge jupyter_bokeh\njupyter labextension install @jupyter-widgets/jupyterlab-manager\njupyter labextension install @bokeh/jupyter_bokeh\n```\n\nTo install a specific version:\n\n```bash\njupyter labextension install @bokeh/jupyter_bokeh@x.y.x\n```\n\n## Compatibility\n\nThe core [Bokeh](https://github.com/bokeh/bokeh) library is generally version independent of\n[JupyterLab](https://github.com/jupyterlab/jupyterlab) and this ``jupyter_bokeh`` extension\nfor versions of ``bokeh>=2.0.0``.\n\nOur goal is that ``jupyter_bokeh`` minor releases (using the [SemVer](https://semver.org/) pattern) are\nmade to follow JupyterLab minor release bumps, while micro releases are for new ``jupyter_bokeh`` features\nor bug fix releases. We've been previously inconsistent with having the extension release minor version bumps\ntrack that of JupyterLab, so users seeking to find extension releases that are compatible with their JupyterLab\ninstallation may refer to the below table.\n\n###### Compatible JupyterLab and `jupyter_bokeh` versions\n\n| JupyterLab | `jupyter_bokeh` |\n| ------------- | ---------------- |\n| 0.34.x | 0.6.2 |\n| 0.35.x | 0.6.3 |\n| 1.0.x | 1.0.0 |\n| 2.0.x | 2.0.0 |\n| 3.0.x | 3.0.0 |\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 jupyter_bokeh 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 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 jupyter_bokeh\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A Jupyter extension for rendering Bokeh content.",
"version": "3.0.5",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "18283c98aa3699e7bfffeb39c36711d0",
"sha256": "7292599c889596488425a9a4ae13fda0b899d1462efc010ec5befdd627a0c1ad"
},
"downloads": -1,
"filename": "jupyter_bokeh-3.0.5.tar.gz",
"has_sig": false,
"md5_digest": "18283c98aa3699e7bfffeb39c36711d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 779745,
"upload_time": "2022-09-20T16:24:56",
"upload_time_iso_8601": "2022-09-20T16:24:56.568145Z",
"url": "https://files.pythonhosted.org/packages/98/90/461fa635cca3b7f76fb87786c8b96bb172192b16e12e1db60b0fcdb99ca9/jupyter_bokeh-3.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-09-20 16:24:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "bokeh",
"github_project": "jupyter_bokeh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyter-bokeh"
}
JSON
