{"name":"napari-serverkit","display_name":"Napari Server Kit","visibility":"public","icon":"","categories":[],"schema_version":"0.2.1","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-serverkit.run","title":"Connect to algorithm server","python_name":"napari_serverkit:ServerKitHttpWidget","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-serverkit.run","display_name":"Server Kit","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.4","name":"napari-serverkit","version":"0.1.2","dynamic":["license-file"],"platform":null,"supported_platform":null,"summary":"Napari client for the imaging-server-kit project.","description":"![EPFL Center for Imaging logo](https://imaging.epfl.ch/resources/logo-for-gitlab.svg)\n# 🪐 Napari Server Kit\n\nRun [Imaging Server Kit](https://github.com/Imaging-Server-Kit/imaging-server-kit) algorithms interactively in [Napari](https://napari.org/stable/).\n\n[screencast.webm](https://github.com/user-attachments/assets/1ac68cc5-da38-4430-819a-30d325a43176)\n\n## Installation\n\nYou can install the plugin either via python *or* the executable installer.\n\n**Python installation**\n\nYou can install `napari-serverkit` via `pip`::\n\n```\npip install napari-serverkit\n```\n\nor clone the project and install the development version:\n\n```\ngit clone https://github.com/Imaging-Server-Kit/napari-serverkit.git\ncd napari-serverkit\npip install -e .\n```\n\nThen, start Napari with the Server Kit plugin from the terminal:\n\n```\nnapari -w napari-serverkit\n```\n\n**Executable installer**\n\nDownload, unzip, and execute the installer from the [Releases](https://github.com/Imaging-Server-Kit/napari-serverkit/releases) page.\n\n## Usage\n\nRefer to the [Imaging Server Kit](https://imaging-server-kit.github.io/imaging-server-kit/) documentation for detailed instructions on how to use the `napari-serverkit` plugin.\n\n**TL;DR**\n\n- In Python, use `sk.to_napari(algo)` to generate a dock widget for an `sk.algorithm` object and use it in Napari.\n- In Napari, connect to an algorithm server via `Plugins > Server Kit (Napari Server Kit)`.\n\n```python\nimport napari\nimport imaging_server_kit as sk\n\n@sk.algorithm\ndef my_algorithm(...):\n    ...\n\nsk.to_napari(my_algorithm)\nnapari.run()\n```\n\n## Contributing\n\nContributions are very welcome.\n\n## License\n\nThis software is distributed under the terms of the [BSD-3](http://opensource.org/licenses/BSD-3-Clause) license.\n\n## Issues\n\nIf you encounter any problems, please file an issue along with a detailed description.\n\n## Acknowledgements\n\nThis project uses the [PyApp](https://github.com/ofek/pyapp) software for creating a runtime installer.\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":null,"author_email":"Mallory Wittwer <mallory.wittwer@epfl.ch>","maintainer":null,"maintainer_email":null,"license":"Copyright (c) 2024, EPFL\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n  list of conditions and the following disclaimer.\n\n* 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* Neither the name of 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\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n","classifier":["Development Status :: 2 - Pre-Alpha","License :: OSI Approved :: BSD License","Programming Language :: Python :: 3","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Topic :: Scientific/Engineering :: Image Processing","Framework :: napari"],"requires_dist":["napari[all]>=0.4.16","qtpy","imaging-server-kit>=0.1","napari-toolkit"],"requires_python":">=3.9","requires_external":null,"project_url":["homepage, https://github.com/EPFL-Center-for-Imaging/napari-serverkit","repository, https://github.com/EPFL-Center-for-Imaging/napari-serverkit"],"provides_extra":null,"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}