# slider2d
A custom 2D slider widget for Jupyter
## Installation
You can install using `pip`:
```bash
pip install slider2d
```
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] slider2d
```
## Development Installation
Create a dev environment:
```bash
conda create -n slider2d -c conda-forge nodejs yarn python=3.10 jupyterlab
conda activate slider2d
```
Install the python. This will also build the TS package.
```bash
pip install -e ".[test, examples]"
pip install jupyter_packaging
yarn
```
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 slider2d
jupyter nbextension enable --sys-prefix --py slider2d
```
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.
Raw data
{
"_id": null,
"home_page": "https://github.com//slider2d",
"name": "slider2d",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,Widgets,IPython",
"author": "nicolvisser",
"author_email": "vissernicol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0b/b7/ba956ca772b7ef02e7ba74cbd4d48c4e4208594ad00ac2de0e71f24478ad/slider2d-0.1.0.tar.gz",
"platform": "Linux",
"description": "\n# slider2d\n\nA custom 2D slider widget for Jupyter\n\n## Installation\n\nYou can install using `pip`:\n\n```bash\npip install slider2d\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] slider2d\n```\n\n## Development Installation\n\nCreate a dev environment:\n```bash\nconda create -n slider2d -c conda-forge nodejs yarn python=3.10 jupyterlab\nconda activate slider2d\n```\n\nInstall the python. This will also build the TS package.\n```bash\npip install -e \".[test, examples]\"\npip install jupyter_packaging\nyarn\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 slider2d\njupyter nbextension enable --sys-prefix --py slider2d\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",
"bugtrack_url": null,
"license": "BSD",
"summary": "A custom 2D slider widget for Jupyter",
"version": "0.1.0",
"split_keywords": [
"jupyter",
"widgets",
"ipython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e94e10639ec8dd309e40e680e9b9c8d7fc5f66a5031b2da79199366545b0b3c",
"md5": "c49bc83ac43618d328c0638523158bcb",
"sha256": "655711ead0c6065a90ec769ae9e95349239127232188424a8835e8f275188521"
},
"downloads": -1,
"filename": "slider2d-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c49bc83ac43618d328c0638523158bcb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 1072446,
"upload_time": "2023-02-02T22:09:46",
"upload_time_iso_8601": "2023-02-02T22:09:46.245627Z",
"url": "https://files.pythonhosted.org/packages/9e/94/e10639ec8dd309e40e680e9b9c8d7fc5f66a5031b2da79199366545b0b3c/slider2d-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bb7ba956ca772b7ef02e7ba74cbd4d48c4e4208594ad00ac2de0e71f24478ad",
"md5": "1998018ef1b2538f0ed61577ffe2cabb",
"sha256": "0f3f374998851f80978298c561d547e9945cfc420f8cc38b452276ee64aa120b"
},
"downloads": -1,
"filename": "slider2d-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1998018ef1b2538f0ed61577ffe2cabb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1027656,
"upload_time": "2023-02-02T22:09:49",
"upload_time_iso_8601": "2023-02-02T22:09:49.142644Z",
"url": "https://files.pythonhosted.org/packages/0b/b7/ba956ca772b7ef02e7ba74cbd4d48c4e4208594ad00ac2de0e71f24478ad/slider2d-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-02 22:09:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "slider2d"
}
JSON