| Name | jppype JSON |
| Version |
0.1.1.1
JSON |
| download |
| home_page | |
| Summary | JupyterLab extension adding data visualisation widgets. |
| upload_time | 2023-05-24 20:00:58 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Gabriel Lepetit-Aimon Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
ipython
jupyter
jupyterlab
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jupyter ProtoPype: jppype
[](https://badge.fury.io/py/jppype)
Jupyter extensions adding ipywidgets specialized for data-view. It is designed as a frontend for ProtoPype (to be released) but can be used as a standalone.
The widgets work both with Jupyter Notebook and Jupyter Lab.
## Installation
To install use pip:
```bash
pip install jppype
```
## Usage
Import jppype in your notebook and use the widgets:
```python
import jppype as jpp
```
### 2D image viewer
```python
viewer = jpp.View2D()
# Supported image formats: numpy array, torch tensor
image = np.random.rand(100, 100)
viewer.add_image(image)
viewer
```
## Features coming...
- __Widgets__
- [x] 2D image viewer
- [x] Color images layer
- [x] Label layer
- [x] Graph layer
- [ ] Vector Field layer
- [ ] Table viewer
- __Python interactivity__
- [x] Add/Update/Remove layers
- [x] Callback on click
- [ ] Async request of user selection (point, area, node, edge...)
## Development Installation
Pull the latest version of the repository
```bash
git clone https://github.com/gabriel-lepetitaimon/jppype.git
cd jppype
````
For a development installation (requires [Node.js](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/)):
```bash
conda create -n jppype python=3.10
conda install -c conda-forge yarn nodejs
```
Download the npm dependencies:
```bash
cd ts-src
npm install
cd ...
```
Upgrade jupyter-lab to version 4.0.0 if necessary:
```bash
pip install -U jupyterlab
```
Install the python package and the extensions in development mode (this stage may take a while as it will build the jupyterlab extension):
```bash
pip install -e .[dev]
jupyter nbextension install --py --symlink --overwrite --sys-prefix jppype
jupyter nbextension enable --py --sys-prefix jppype
```
If you which to develop for JupyterLab, also run the command:
```bash
jupyter labextension develop --overwrite jppype
```
Then you need to rebuild the JS when you make a code change:
```bash
cd ts-src
jlpm clean
jlpm build
```
or automatically rebuild when a file changes:
```bash
cd ts-src
npm watch
```
You then need to refresh the JupyterLab page when your javascript changes.
Raw data
{
"_id": null,
"home_page": "",
"name": "jppype",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "IPython,Jupyter,JupyterLab,Widgets",
"author": "",
"author_email": "Gabriel Lepetit-Aimon <gabriel.lepetitaimon@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f1/d1/79b513b5afa4ebb8bfb3dab28a450f1cad51cec36fdeb5c4eaa721558548/jppype-0.1.1.1.tar.gz",
"platform": null,
"description": "# Jupyter ProtoPype: jppype\n[](https://badge.fury.io/py/jppype)\n\nJupyter extensions adding ipywidgets specialized for data-view. It is designed as a frontend for ProtoPype (to be released) but can be used as a standalone.\n\nThe widgets work both with Jupyter Notebook and Jupyter Lab.\n\n## Installation\n\nTo install use pip:\n\n```bash\npip install jppype\n```\n\n## Usage\nImport jppype in your notebook and use the widgets:\n```python\nimport jppype as jpp\n```\n\n### 2D image viewer\n```python\nviewer = jpp.View2D()\n\n# Supported image formats: numpy array, torch tensor\nimage = np.random.rand(100, 100) \nviewer.add_image(image)\nviewer\n```\n\n## Features coming...\n\n- __Widgets__\n - [x] 2D image viewer\n - [x] Color images layer\n - [x] Label layer\n - [x] Graph layer\n - [ ] Vector Field layer\n - [ ] Table viewer\n\n\n- __Python interactivity__\n - [x] Add/Update/Remove layers\n - [x] Callback on click\n - [ ] Async request of user selection (point, area, node, edge...) \n\n## Development Installation\n\nPull the latest version of the repository\n```bash\ngit clone https://github.com/gabriel-lepetitaimon/jppype.git\ncd jppype\n````\n\nFor a development installation (requires [Node.js](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/)):\n```bash\nconda create -n jppype python=3.10\nconda install -c conda-forge yarn nodejs\n```\n\nDownload the npm dependencies:\n```bash\ncd ts-src\nnpm install\ncd ...\n```\n\nUpgrade jupyter-lab to version 4.0.0 if necessary:\n```bash\npip install -U jupyterlab\n```\n\nInstall the python package and the extensions in development mode (this stage may take a while as it will build the jupyterlab extension):\n```bash\npip install -e .[dev]\njupyter nbextension install --py --symlink --overwrite --sys-prefix jppype\njupyter nbextension enable --py --sys-prefix jppype\n```\nIf you which to develop for JupyterLab, also run the command:\n```bash\njupyter labextension develop --overwrite jppype\n```\n\nThen you need to rebuild the JS when you make a code change:\n```bash\ncd ts-src\njlpm clean\njlpm build\n```\nor automatically rebuild when a file changes:\n```bash\ncd ts-src\nnpm watch\n```\n\nYou then need to refresh the JupyterLab page when your javascript changes.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Gabriel Lepetit-Aimon Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "JupyterLab extension adding data visualisation widgets.",
"version": "0.1.1.1",
"project_urls": {
"Homepage": "https://github.com/gabriel-lepetitaimon/jppype",
"Source": "https://github.com/gabriel-lepetitaimon/jppype"
},
"split_keywords": [
"ipython",
"jupyter",
"jupyterlab",
"widgets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "874e5112d7b382d4d90114e663d3ee36ef0d7e69726e438e17646847b6fed782",
"md5": "482f8beb95a6323d33f7eef16bce8349",
"sha256": "0a1a884eaa40c805d86dbd292a7ad169ffc8e7de503f33d61bfbf335a8dbd2e8"
},
"downloads": -1,
"filename": "jppype-0.1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "482f8beb95a6323d33f7eef16bce8349",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 400508,
"upload_time": "2023-05-24T20:00:56",
"upload_time_iso_8601": "2023-05-24T20:00:56.165591Z",
"url": "https://files.pythonhosted.org/packages/87/4e/5112d7b382d4d90114e663d3ee36ef0d7e69726e438e17646847b6fed782/jppype-0.1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1d179b513b5afa4ebb8bfb3dab28a450f1cad51cec36fdeb5c4eaa721558548",
"md5": "c5e50c7263a098b03306542ede50ce79",
"sha256": "309024bf509d96e87a484b5bbe9e4ee0e4c81f9ebf72c0f91dceb33c66efaec9"
},
"downloads": -1,
"filename": "jppype-0.1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c5e50c7263a098b03306542ede50ce79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 301363,
"upload_time": "2023-05-24T20:00:58",
"upload_time_iso_8601": "2023-05-24T20:00:58.792094Z",
"url": "https://files.pythonhosted.org/packages/f1/d1/79b513b5afa4ebb8bfb3dab28a450f1cad51cec36fdeb5c4eaa721558548/jppype-0.1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-24 20:00:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gabriel-lepetitaimon",
"github_project": "jppype",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jppype"
}
