{"name":"napari-stream","display_name":"Napari Stream","visibility":"public","icon":"","categories":[],"schema_version":"0.2.1","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-stream.start_receiver","title":"Start Stream Receiver","python_name":"napari_stream._receiver_widget:receiver_widget","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-stream.start_receiver","display_name":"Stream Receiver","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.4","name":"napari-stream","version":"0.1.2","dynamic":["license-file"],"platform":null,"supported_platform":null,"summary":"A plugin to send and receive multi-dimensional image data for visualization in Napari over the network.","description":"

\n \"Alt\n

\n\n______________________________________________________________________\n\n[![License MIT](https://img.shields.io/pypi/l/napari-stream.svg?color=green)](https://github.com/Karol-G/napari-stream/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-stream.svg?color=green)](https://pypi.org/project/napari-stream)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-stream.svg?color=green)](https://python.org)\n[![codecov](https://codecov.io/gh/Karol-G/napari-stream/branch/main/graph/badge.svg)](https://codecov.io/gh/Karol-G/napari-stream)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-stream)](https://napari-hub.org/plugins/napari-stream)\n[![npe2](https://img.shields.io/badge/plugin-npe2-blue?link=https://napari.org/stable/plugins/index.html)](https://napari.org/stable/plugins/index.html)\n[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)\n\nA plugin to send and receive multi-dimensional image data for visualization in Napari over the network.\n\n`napari-stream` lets you push images from any application, process, or codebase into a running napari instance—even from another machine. It can automatically pull array-like data (NumPy, PyTorch tensors, zarr arrays, etc.) from nested Python lists and dicts, so you can stream complex structures without manual extraction. You can keep things private (local IPC/loopback) or make the receiver reachable publicly over TCP. The receiver endpoint can also be set via the `NAPARI_STREAM_ENDPOINT` environment variable.\n\n## Quick usage\n\n```python\nfrom napari_stream.sender import StreamSender, send\nimport numpy as np\n\n# Option 1: explicit sender (recommended when reusing across many sends)\nsender = StreamSender(endpoint=\"tcp://192.0.2.10:5556\") # or leave None to use NAPARI_STREAM_ENDPOINT/default\nsender.send(np.random.rand(256, 256), name=\"image\")\n\n# Option 2: convenience function; pass connection kwargs through\nsend(np.random.rand(64, 64), name=\"quick\", endpoint=\"tcp://127.0.0.1:5556\")\n```\n\nOn the receiving side, open the napari dock widget, choose your endpoint, and toggle public access if you want to accept connections from other machines.\n\n\n## Installation\n\nYou can install `napari-stream` via [pip]:\n\n```\npip install napari-stream\n```\n\nIf napari is not already installed, you can install `napari-stream` with napari and Qt via:\n\n```\npip install \"napari-stream[all]\"\n```\n\n\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"napari-stream\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[copier]: https://copier.readthedocs.io/en/stable/\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[napari-plugin-template]: https://github.com/napari/napari-plugin-template\n\n[napari]: https://github.com/napari/napari\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n\n# Acknowledgments\n\n

\n     \n \n

\n\nThis repository is developed and maintained by the Applied Computer Vision Lab (ACVL)\nof [Helmholtz Imaging](https://www.helmholtz-imaging.de/) and the\n[Division of Medical Image Computing](https://www.dkfz.de/en/medical-image-computing) at DKFZ.\n\nThis repository was generated with [copier] using the [napari-plugin-template].\n\n[copier]: https://copier.readthedocs.io/en/stable/\n[napari-plugin-template]: https://github.com/napari/napari-plugin-template\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":"Karol Gotkowski","author_email":"karol.gotkowski@dkfz.de","maintainer":null,"maintainer_email":null,"license":"The MIT License (MIT)\n\nCopyright (c) 2025 Division of Medical Image Computing, German Cancer Research Center (DKFZ), Heidelberg, Germany\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","classifier":["Development Status :: 2 - Pre-Alpha","Framework :: napari","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["numpy","pyzmq","medvol","napari[all]; extra == \"all\"","qtpy; extra == \"test\""],"requires_python":">=3.10","requires_external":null,"project_url":null,"provides_extra":["all","test"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}