napari-plugin-manager 0.1.0__tar.gz

napari_plugin_manager-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      github-actions:
+        patterns:
+          - "*"

napari_plugin_manager-0.1.0/.github/workflows/deploy_docs.yml

@@ -0,0 +1,60 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+# Only allow one docs build at a time so that overlapping stale builds will get
+# cancelled automatically.
+concurrency:
+  group: deploy_docs
+  cancel-in-progress: true
+
+jobs:
+  build-and-deploy:
+    name: Build & Deploy
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # so we can write to github pages without a token
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    steps:
+    - name: Clone repo
+      uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+    - uses: tlambert03/setup-qt-libs@v1
+
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install "napari[all]"
+        python -m pip install -e ".[docs]"
+
+    - name: Build Docs
+      uses: aganders3/headless-gui@v2
+      with:
+        run: make docs
+
+    - name: Check file tree contents
+      run: tree
+
+    # At a minimum this job should upload artifacts using actions/upload-pages-artifact
+    - name: Upload GitHub Pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        name: github-pages
+        path: docs/_build
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action

napari_plugin_manager-0.1.0/.github/workflows/test_and_deploy.yml

@@ -0,0 +1,106 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: test and deploy
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  # Concurrency group that uses the workflow name and PR number if available
+  # or commit SHA as a fallback. If a new build is triggered under that
+  # concurrency group while a previous build is running it will be canceled.
+  # Repeated pushes to a PR will cancel all previous builds, while multiple
+  # merges to main will not cancel.
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: ${{ matrix.platform }}, py${{ matrix.python-version }}, napari ${{ matrix.napari }}
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macos-13]
+        python-version: ["3.9", "3.10", "3.11"]
+        napari: ["latest", "repo"]
+        exclude:
+          # TODO: Remove when we have a napari release with the plugin manager changes
+          - napari: "latest"
+          # TODO: PyQt / PySide wheels missing
+          - python-version: "3.11"
+            platform: "windows-latest"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: tlambert03/setup-qt-libs@v1
+
+      # strategy borrowed from vispy for installing opengl libs on windows
+      - name: Install Windows OpenGL
+        if: runner.os == 'Windows'
+        run: |
+          git clone --depth 1 https://github.com/pyvista/gl-ci-helpers.git
+          powershell gl-ci-helpers/appveyor/install_opengl.ps1
+          if (Test-Path -Path "C:\Windows\system32\opengl32.dll" -PathType Leaf) {Exit 0} else {Exit 1}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools tox tox-gh-actions
+
+      - name: Test with tox
+        uses: aganders3/headless-gui@v2
+        with:
+          run: python -m tox -vv
+        env:
+          PYVISTA_OFF_SCREEN: True  # required for opengl on windows
+          NAPARI: ${{ matrix.napari }}
+          FORCE_COLOR: 1
+          # PySide6 only functional with Python 3.10+
+          TOX_SKIP_ENV: ".*py39-PySide6.*"
+
+      - name: Coverage
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  deploy:
+    # this will run when you have tagged a commit, starting with "v*"
+    # and requires that you have put your twine API key in your
+    # github secrets (see readme for details)
+    needs: [test]
+    runs-on: ubuntu-latest
+    if: contains(github.ref, 'tags')
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U setuptools build
+      - name: Build
+        run: |
+          git tag
+          python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

napari_plugin_manager-0.1.0/.gitignore

@@ -0,0 +1,119 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+.napari_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask instance folder
+instance/
+
+# Sphinx documentation
+docs/_build/
+
+# MkDocs documentation
+/site/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# OS
+.DS_Store
+
+# written by setuptools_scm
+*/_version.py
+
+# pycharm stuff
+.idea/
+
+# ruff stuff
+.ruff_cache/
+
+# spyder stuff
+.spyproject/
+
+# Environment variables file
+.env
+
+# Sphinx documentation
+docs/_build/
+
+# MkDocs documentation
+/site/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# OS
+.DS_Store
+
+# written by setuptools_scm
+*/_version.py
+
+# vscode
+.vscode
+
+# Images
+docs/images/
+

napari_plugin_manager-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/MarcoGorelli/absolufy-imports
+    rev: v0.3.1
+    hooks:
+      - id: absolufy-imports
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v2.4.0
+    hooks:
+      - id: pycln
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.4.2
+    hooks:
+      - id: black
+        pass_filenames: true
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
+    hooks:
+      - id: ruff
+  - repo: https://github.com/seddonym/import-linter
+    rev: v2.0
+    hooks:
+    - id: import-linter
+      stages: [manual]
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.28.6
+    hooks:
+      - id: check-github-workflows
+
+ci:
+  autoupdate_schedule: monthly

napari_plugin_manager-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2018, Napari
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* 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.
+
+* 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.

napari_plugin_manager-0.1.0/Makefile

@@ -0,0 +1,43 @@
+.PHONY: docs clean
+
+SPHINXOPTS =
+
+mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
+current_dir := $(dir $(mkfile_path))
+docs_dir := $(current_dir)docs
+
+clean:
+	echo clean
+	echo $(current_dir)
+	rm -rf $(docs_dir)/_build/
+	rm -rf $(docs_dir)/images/
+	mkdir $(docs_dir)/images/
+	cp images/*.png $(docs_dir)/images/
+
+docs-build:
+	NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b html docs/ docs/_build $(SPHINXOPTS)
+
+docs-xvfb:
+	NAPARI_CONFIG="" NAPARI_APPLICATION_IPY_INTERACTIVE=0 xvfb-run --auto-servernum sphinx-build -b html docs/ docs/_build $(SPHINXOPTS)
+
+docs: clean docs-build
+
+serve: 
+	python -m http.server -d $(docs_dir)/_build
+# Implies noplot, but no clean - call 'make clean' manually if needed
+# Autogenerated paths need to be ignored to prevent reload loops
+html-live:
+	NAPARI_APPLICATION_IPY_INTERACTIVE=0 \
+	sphinx-autobuild \
+		-b html \
+		docs/ \
+		docs/_build \
+		--open-browser \
+		--port=0 \
+		$(SPHINXOPTS)
+
+html-noplot: clean
+	NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b html docs/ docs/_build $(SPHINXOPTS)
+
+linkcheck-files:
+	NAPARI_APPLICATION_IPY_INTERACTIVE=0 sphinx-build -b linkcheck --color docs/ docs/_build ${FILES} $(SPHINXOPTS)

napari_plugin_manager-0.1.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.1
+Name: napari-plugin-manager
+Version: 0.1.0
+Summary: Install plugins for napari, in napari.
+Author-email: napari team <napari-steering-council@googlegroups.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2018, Napari
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * 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.
+        
+        * 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.
+        
+Project-URL: homepage, https://github.com/napari/napari-plugin-manager
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: X11 Applications :: Qt
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Topic :: Utilities
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: npe2
+Requires-Dist: qtpy
+Requires-Dist: superqt
+Requires-Dist: pip
+Provides-Extra: dev
+Requires-Dist: PyQt5; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: testing
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: virtualenv; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-qt; extra == "testing"
+Provides-Extra: docs
+Requires-Dist: sphinx>6; extra == "docs"
+Requires-Dist: sphinx-autobuild; extra == "docs"
+Requires-Dist: sphinx-external-toc; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-favicon; extra == "docs"
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: napari-sphinx-theme>=0.3.0; extra == "docs"
+
+# napari-plugin-manager
+
+[![License](https://img.shields.io/pypi/l/napari-plugin-manager.svg?color=green)](https://github.com/napari/napari-plugin-manager/raw/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/napari-plugin-manager.svg?color=green)](https://pypi.org/project/napari-plugin-manager)
+[![Python Version](https://img.shields.io/pypi/pyversions/napari-plugin-manager.svg?color=green)](https://python.org)
+[![tests](https://github.com/napari/napari-plugin-manager/actions/workflows/test_and_deploy.yml/badge.svg)](https://github.com/napari/napari-plugin-manager/actions/workflows/test_and_deploy.yml)
+[![codecov](https://codecov.io/gh/napari/napari-plugin-manager/branch/main/graph/badge.svg)](https://codecov.io/gh/napari/napari-plugin-manager)
+
+[napari] plugin manager to provide a graphical user interface for installing
+[napari] plugins.
+
+You can read the documentation at [napari.org/napari-plugin-manager](https://napari.org/napari-plugin-manager).
+
+## Overview
+
+The `napari-plugin-manager` used to be part of the [napari] codebase before the 0.5.x release
+series. It's now maintained as a separate project and package to allow uncoupled iterations outside
+of the `napari` release cycle.
+
+Future work will allow other applications with a plugin ecosytem to customize and 
+use the `plugin-manager`. This package remains under active development and contributions
+are very welcome. Please [open an issue] to discuss potential improvements.
+
+This package currently provides:
+
+- A package installer process queue that supports both [pip] and [conda] installs.
+- An easy to use GUI for searching, installing, uninstalling and updating plugins that make part of
+  the napari ecosystem. Each plugin entry provides a summary and information on the authors that
+  created the package. The REST API used to query for plugins and plugin information is provided by
+  the [npe2api service](https://api.napari.org).
+- The ability to install other packages via URL of by dragging and dropping artifacts from [PyPI].
+
+![Screenshot of the napari-plugin-manager interface, showcasing the plugin descriptions](./images/description.png)
+
+`napari-plugin-manager` knows how to detect if napari was installed using `conda` or `pip` and
+provide the appropriate default installer tool on the `Installation Info` dropdown for each plugin.
+
+`conda` provides an efficient dependency solver that guarantees the stability and correctness of
+the napari installation and work environment. This is the reason why `conda` is the default tool
+used for the [napari
+bundle](https://napari.org/stable/tutorials/fundamentals/installation_bundle_conda.html), a 1-click
+installer available for Mac, Linux and Windows. This installation method is best if you mainly want
+to use napari as a standalone GUI app. However, certain plugins may not be supported.
+
+## Installation
+
+### PyPI
+
+`napari-plugin-manager` is available through the Python Package Index and can be installed using [pip].
+
+```bash
+pip install napari-plugin-manager
+```
+
+### Conda
+
+`napari-plugin-manager` is also available for install using [conda] through the [conda-forge channel](https://conda-forge.org/docs/#what-is-conda-forge).
+
+
+```bash
+conda install napari-plugin-manager -c conda-forge
+```
+
+## Using the napari plugin manager
+
+### Enabling/Disabling plugins
+
+Installed plugins found on the current napari installation are displayed on the top list of the UI.
+
+Users of napari can choose to enable/disable a specific plugin by checking/unchecking the checkbox
+to the left of each plugin item in the list.
+
+### Filtering
+
+You can filter available plugins by name or description by typing on the search box
+on the top left corner of the UI. Only plugins that match the filter criteria will be shown.
+
+In the image below filtering by the word `arcos` yields a single plugin, the
+`arcos-gui` plugin. Notice that plugins that provide a display name, will show
+the package name to the right in parenthesis.
+
+![Screenshot of the napari-plugin-manager interface showcasing the filtering features with the query 'arcos'](./images/filter.png)
+
+### Refreshing
+
+If a new plugin has been released but it is not available on the list, you can click on the
+`Refresh` button located at the top right corner, to clear the cache and load all newly
+available plugins.
+
+### Installing a plugin
+
+To install a plugin:
+
+1. Select it by scrolling the available plugins list on the bottom, or by directly
+filtering by name or description.
+2. Select the tool (`conda` or `pip`) and version on the `Installation Info` dropdown.
+3. Start the installation process by clicking on the `Install` button.
+
+You can cancel the process at any time by clicking the `Cancel` button of each plugin.
+
+**Note**: Not all napari plugins are currently available on conda via the
+[conda-forge channel](https://anaconda.org/conda-forge/). Some plugins will require
+a restart to be properly configured.
+
+![Screenshot of the napari-plugin-manager showing the process of installing a plugin](./images/install.png)
+
+### Uninstalling a plugin
+
+To uninstall a plugin:
+
+1. Select it by scrolling the installed plugins list on the top, or by directly
+filtering by name or description.
+2. Start the removal process by clicking on the `Uninstall` button.
+
+You can cancel the process at any time by clicking the `Cancel` button of each plugin.
+
+**Note**: Some plugins will require a restart to be properly removed.
+
+![Screenshot of the napari-plugin-manager showing the process of uninstalling a plugin](./images/uninstall.png)
+
+### Updating a plugin
+
+When a new version of an installed plugin is available, an `Update (vX.Y.Z)`
+button will appear to the left of the `Installation Info` dropdown.
+
+To update a plugin:
+
+1. Select it by scrolling the install plugins list on the top, or by directly
+filtering by name or description.
+2. Start the update process by clicking on the `Update (vX.Y.Z)` button.
+
+You can cancel the process at any time by clicking the `Cancel` button of each plugin.
+
+![Screenshot of the napari-plugin-manager showing the process of updating a plugin](./images/update.png)
+
+### Batch actions
+
+You don't need wait for one action to finish before you can start another one. You can add more
+tasks to the queue (install/uninstall/update) by clicking on the corresponding action buttons
+plugin by plugin. The actions will be carried out sequentially and in the order in which you
+started them.
+
+You can cancel all the started installer actions at any time by clicking `Cancel all`
+button at the bottom of the UI.
+
+## Troubleshooting
+
+In order to visualize more detailed information on the installer process output, you can
+click on the `Show status` button located at the bottom left corner of the UI. To hide
+this detailed information you can click on the `Hide status` button.
+
+Some issues that you might experience when using the installer include:
+
+* Incompatible packages due to conflicting dependencies.
+* Network connectivity errors.
+
+![Screenshot of the napari-plugin-amanger interface showcasing the status information, which is initially hidden by default.](./images/status.png)
+
+## License
+
+Distributed under the terms of the [BSD-3] license, "napari-plugin-manager" is free and open source
+software.
+
+## Issues
+
+If you encounter any problems, please [file an issue] along with a detailed description.
+
+[napari]: https://github.com/napari/napari
+[@napari]: https://github.com/napari
+[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
+[file an issue]: https://github.com/napari/napari-plugin-manager/issues
+[open an issue]: https://github.com/napari/napari-plugin-manager/issues
+[pip]: https://pypi.org/project/pip/
+[conda]: https://conda.org
+[PyPI]: https://pypi.org/