# webgui_jupyter_widgets
[](https://travis-ci.org/CERBSim/webgui_jupyter_widgets)
[](https://codecov.io/gh/CERBSim/webgui_jupyter_widgets)
Jupyter widgetds library for webgui js visualization library'
## Installation
You can install using `pip`:
```bash
pip install webgui_jupyter_widgets
```
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:
```bash
jupyter nbextension enable --py [--sys-prefix|--user|--system] webgui_jupyter_widgets
```
## Development Installation
Create a dev environment:
```bash
conda create -n webgui_jupyter_widgets-dev -c conda-forge nodejs yarn python jupyterlab
conda activate webgui_jupyter_widgets-dev
```
Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
```
When developing your extensions, you need to manually enable your extensions with the
notebook / lab frontend. For lab, this is done by the command:
```
jupyter labextension develop --overwrite .
yarn run build
```
For classic notebook, you need to run:
```
jupyter nbextension install --sys-prefix --symlink --overwrite --py webgui_jupyter_widgets
jupyter nbextension enable --sys-prefix --py webgui_jupyter_widgets
```
Note that the `--symlink` flag doesn't work on Windows, so you will here have to run
the `install` command every time that you rebuild your extension. For certain installations
you might also need another flag instead of `--sys-prefix`, but we won't cover the meaning
of those flags here.
### How to see your changes
#### Typescript:
If you use JupyterLab to develop then 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 widget.
```bash
# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab
```
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
#### Python:
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.
# Build with development version of webgui
```code
# initial setup
git clone https://github.com/CERBSim/webgui_jupyter_widgets.git
cd webgui_jupyter_widgets
git submodule update --init --recursive
pip install --user .
jupyter nbextension install --user --py webgui_jupyter_widgets
# build dev version of webgui
cd webgui
git checkout main
git pull
cd ..
pip install --user .
```
Raw data
{
"_id": null,
"home_page": "https://github.com/CERBSim/webgui_jupyter_widgets",
"name": "webgui-jupyter-widgets",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,Widgets,IPython",
"author": "CERBSim",
"author_email": "mhochsteger@cerbsim.com",
"download_url": "",
"platform": "Linux",
"description": "\n# webgui_jupyter_widgets\n\n[](https://travis-ci.org/CERBSim/webgui_jupyter_widgets)\n[](https://codecov.io/gh/CERBSim/webgui_jupyter_widgets)\n\n\nJupyter widgetds library for webgui js visualization library'\n\n## Installation\n\nYou can install using `pip`:\n\n```bash\npip install webgui_jupyter_widgets\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] webgui_jupyter_widgets\n```\n\n## Development Installation\n\nCreate a dev environment:\n```bash\nconda create -n webgui_jupyter_widgets-dev -c conda-forge nodejs yarn python jupyterlab\nconda activate webgui_jupyter_widgets-dev\n```\n\nInstall the python. This will also build the TS package.\n```bash\npip install -e \".[test, examples]\"\n```\n\nWhen developing your extensions, you need to manually enable your extensions with the\nnotebook / lab frontend. For lab, this is done by the command:\n\n```\njupyter labextension develop --overwrite .\nyarn run build\n```\n\nFor classic notebook, you need to run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py webgui_jupyter_widgets\njupyter nbextension enable --sys-prefix --py webgui_jupyter_widgets\n```\n\nNote that the `--symlink` flag doesn't work on Windows, so you will here have to run\nthe `install` command every time that you rebuild your extension. For certain installations\nyou might also need another flag instead of `--sys-prefix`, but we won't cover the meaning\nof those flags here.\n\n### How to see your changes\n#### Typescript:\nIf you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different\nterminals to watch for changes in the extension's source and automatically rebuild the widget.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\nyarn run watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nAfter a change wait for the build to finish and then refresh your browser and the changes should take effect.\n\n#### Python:\nIf you make a change to the python code then you will need to restart the notebook kernel to have it take effect.\n\n\n# Build with development version of webgui\n```code\n# initial setup\ngit clone https://github.com/CERBSim/webgui_jupyter_widgets.git\ncd webgui_jupyter_widgets\ngit submodule update --init --recursive\npip install --user .\njupyter nbextension install --user --py webgui_jupyter_widgets\n\n# build dev version of webgui\ncd webgui\ngit checkout main\ngit pull\ncd ..\npip install --user .\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Jupyter widgets library for webgui js visualization library",
"version": "0.2.28",
"project_urls": {
"Homepage": "https://github.com/CERBSim/webgui_jupyter_widgets"
},
"split_keywords": [
"jupyter",
"widgets",
"ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dfa5cf9fff0c3fd3b56317c2575bc4ab583447ed43e7ae16b5ee7b94ff33fef",
"md5": "c88852628038469713b21b6841d79a3c",
"sha256": "7936d0db53f840013f26cf8de7f0a473e013208295ce98c9e495c6a2645fe5e8"
},
"downloads": -1,
"filename": "webgui_jupyter_widgets-0.2.28-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c88852628038469713b21b6841d79a3c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 2525214,
"upload_time": "2024-02-26T21:53:07",
"upload_time_iso_8601": "2024-02-26T21:53:07.761496Z",
"url": "https://files.pythonhosted.org/packages/2d/fa/5cf9fff0c3fd3b56317c2575bc4ab583447ed43e7ae16b5ee7b94ff33fef/webgui_jupyter_widgets-0.2.28-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 21:53:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CERBSim",
"github_project": "webgui_jupyter_widgets",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"lcname": "webgui-jupyter-widgets"
}
JSON
