| Name | net-vis JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | NetVis is a package for interactive visualization Python NetworkX graphs within Jupyter Lab. It leverages D3.js for dynamic rendering and supports HTML export, making network analysis effortless. |
| upload_time | 2025-07-12 03:42:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License
Copyright (c) 2025, CMScom
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 |
ipython
jupyter
widgets
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# netvis
NetVis is a package for interactive visualization Python NetworkX graphs within Jupyter Lab. It leverages D3.js for dynamic rendering and supports HTML export, making network analysis effortless.
## Installation
You can install using `pip`:
```bash
pip install net_vis
```
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] net_vis
```
## Quick Start
This section provides a simple guide to get started with the project using JupyterLab.
### Example
```
import net_vis
data = """
{
"nodes": [
{
"page_id": 1,
"id": "Network"
},
{
"page_id": 2,
"id": "Graph"
}
],
"links": [
{
"source": "Network",
"target": "Graph"
}
]
}
"""
w = net_vis.NetVis(value=data)
w
```
When executed, an SVG network graph is displayed.
- Display Sample
## Development Installation
Create a dev environment:
```bash
conda create -n net_vis-dev -c conda-forge nodejs python jupyterlab=4.0.11
conda activate net_vis-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 .
jlpm run build
```
For classic notebook, you need to run:
```
jupyter nbextension install --sys-prefix --symlink --overwrite --py net_vis
jupyter nbextension enable --sys-prefix --py net_vis
```
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
jlpm 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.
## Contributing
Contributions are welcome!
For details on how to contribute, please refer to [CONTRIBUTING.md](https://github.com/cmscom/netvis/blob/main/CONTRIBUTING.md).
## Special Thanks
This project was initiated on the proposal of Shingo Tsuji. His invaluable contributions —from conceptual planning to requirements definition— have been instrumental in bringing this project to fruition. We extend our deepest gratitude for his vision and support.
Raw data
{
"_id": null,
"home_page": null,
"name": "net-vis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "IPython, Jupyter, Widgets",
"author": null,
"author_email": "Manabu TERADA <terada@cmscom.jp>",
"download_url": "https://files.pythonhosted.org/packages/70/e9/506aafe054187a938d298b8d242462480d916b9490c05e61780dc6997ad1/net_vis-0.3.1.tar.gz",
"platform": null,
"description": "# netvis\n\nNetVis is a package for interactive visualization Python NetworkX graphs within Jupyter Lab. It leverages D3.js for dynamic rendering and supports HTML export, making network analysis effortless.\n\n## Installation\n\nYou can install using `pip`:\n\n```bash\npip install net_vis\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] net_vis\n```\n\n## Quick Start\n\nThis section provides a simple guide to get started with the project using JupyterLab.\n\n### Example\n\n```\nimport net_vis\ndata = \"\"\"\n{\n \"nodes\": [\n {\n \"page_id\": 1,\n \"id\": \"Network\"\n },\n {\n \"page_id\": 2,\n \"id\": \"Graph\"\n }\n ],\n \"links\": [\n {\n \"source\": \"Network\",\n \"target\": \"Graph\"\n }\n ]\n}\n\"\"\"\n\nw = net_vis.NetVis(value=data)\nw\n```\n\nWhen executed, an SVG network graph is displayed.\n\n- Display Sample\n\n\n\n## Development Installation\n\nCreate a dev environment:\n\n```bash\nconda create -n net_vis-dev -c conda-forge nodejs python jupyterlab=4.0.11\nconda activate net_vis-dev\n```\n\nInstall the python. This will also build the TS package.\n\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 .\njlpm run build\n```\n\nFor classic notebook, you need to run:\n\n```\njupyter nbextension install --sys-prefix --symlink --overwrite --py net_vis\njupyter nbextension enable --sys-prefix --py net_vis\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\n#### Typescript:\n\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\njlpm 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:\n\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## Contributing\n\nContributions are welcome! \nFor details on how to contribute, please refer to [CONTRIBUTING.md](https://github.com/cmscom/netvis/blob/main/CONTRIBUTING.md).\n\n## Special Thanks\n\nThis project was initiated on the proposal of Shingo Tsuji. His invaluable contributions \u2014from conceptual planning to requirements definition\u2014 have been instrumental in bringing this project to fruition. We extend our deepest gratitude for his vision and support.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) 2025, CMScom\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "NetVis is a package for interactive visualization Python NetworkX graphs within Jupyter Lab. It leverages D3.js for dynamic rendering and supports HTML export, making network analysis effortless.",
"version": "0.3.1",
"project_urls": {
"ChangeLog": "https://github.com/cmscom/netvis/blob/main/CHANGES.md",
"Homepage": "https://github.com/cmscom/netvis"
},
"split_keywords": [
"ipython",
" jupyter",
" widgets"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "829f4643d4cc9d52c892d1b12808262f39ffe931fea23be820615e77f8946e75",
"md5": "5be5731cd75eccacc984414103d6a990",
"sha256": "aea99da2316cc646aa51a375702b238899152b9d409ba9681fba602e49180f68"
},
"downloads": -1,
"filename": "net_vis-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5be5731cd75eccacc984414103d6a990",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 1050406,
"upload_time": "2025-07-12T03:42:10",
"upload_time_iso_8601": "2025-07-12T03:42:10.511880Z",
"url": "https://files.pythonhosted.org/packages/82/9f/4643d4cc9d52c892d1b12808262f39ffe931fea23be820615e77f8946e75/net_vis-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "70e9506aafe054187a938d298b8d242462480d916b9490c05e61780dc6997ad1",
"md5": "699ce883036a9ec56d26786b2dc7611b",
"sha256": "bf87a124d03485df99ac4ca21cb671868ba890139774db3ead0c26432d73f365"
},
"downloads": -1,
"filename": "net_vis-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "699ce883036a9ec56d26786b2dc7611b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 664037,
"upload_time": "2025-07-12T03:42:12",
"upload_time_iso_8601": "2025-07-12T03:42:12.166792Z",
"url": "https://files.pythonhosted.org/packages/70/e9/506aafe054187a938d298b8d242462480d916b9490c05e61780dc6997ad1/net_vis-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-12 03:42:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cmscom",
"github_project": "netvis",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "net-vis"
}
