napari-plugin-manager 0.1.3__tar.gz → 0.1.5rc0__tar.gz

napari_plugin_manager-0.1.5rc0/.github/workflows/test_and_deploy.yml

@@ -0,0 +1,203 @@
+# 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 }}, ${{ matrix.tool }}
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macos-13, macos-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+        napari: ["latest", "repo"]
+        tool: ["pip", "conda"]
+        include:
+          # add 3.13 on ubuntu
+          - platform: ubuntu-latest
+            napari: repo
+            tool: pip
+            python-version: "3.13"
+        exclude:
+        # skip repo install on conda
+        - platform: ubuntu-latest
+          napari: repo
+          tool: conda
+        - platform: windows-latest
+          napari: repo
+        - platform: macos-13
+          napari: repo
+        - platform: macos-latest
+          napari: repo
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }} - pip
+        if: matrix.tool == 'pip'
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python ${{ matrix.python-version }} - conda
+        if: matrix.tool == 'conda'
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: latest
+          channels: conda-forge
+          conda-remove-defaults: "true"
+          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 without tox-conda
+        if: matrix.tool == 'pip'
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools tox tox-gh-actions tox-uv
+
+      - name: Install dependencies including tox-conda
+        if: matrix.tool == 'conda'
+        shell: bash -el {0}
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools 'tox<4' tox-gh-actions tox-conda
+
+      - name: Test with tox - pip
+        if: matrix.tool == 'pip'
+        uses: aganders3/headless-gui@v2
+        with:
+          run: python -m tox
+        env:
+          PYVISTA_OFF_SCREEN: True  # required for opengl on windows
+          NAPARI: ${{ matrix.napari }}
+          TOOL: ${{ matrix.tool }}
+          FORCE_COLOR: 1
+          # Only supported pyside6 is not supported on py312, py313
+          TOX_SKIP_ENV: ".*py31[23].*PySide6"
+          
+      - name: Test with tox - conda
+        if: matrix.tool == 'conda'
+        uses: aganders3/headless-gui@v2
+        with:
+          shell: bash -el {0}
+          run: python -m tox
+        env:
+          PYVISTA_OFF_SCREEN: True  # required for opengl on windows
+          NAPARI: ${{ matrix.napari }}
+          TOOL: ${{ matrix.tool }}
+          FORCE_COLOR: 1
+          # Only supported pyside2 and pyside6 are not supported on py312, py313
+          # no Qt backends supported by conda-forge on py313
+          TOX_SKIP_ENV: ".*py31[23].*PySide[26]|.*py313.*conda"
+
+          
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage reports ${{ matrix.platform }} py ${{ matrix.python-version }} ${{ matrix.tool }} ${{ matrix.napari }}
+          include-hidden-files: true
+          path: |
+            ./.coverage.*
+
+
+  upload_coverage:
+    permissions:
+      id-token: write  # Required for OIDC authentication
+      contents: read    # Required for code checkout
+    name: Upload coverage
+    needs: [test]
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+          cache-dependency-path: pyproject.toml
+          cache: 'pip'
+
+      - name: Install Dependencies
+        run: |
+          pip install --upgrade pip
+          pip install codecov
+
+      - name: Download coverage data
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage reports*
+          path: coverage
+          merge-multiple: true
+
+
+      - name: combine coverage data
+        run: |
+          python -Im coverage combine coverage
+          python -Im coverage xml -o coverage.xml
+
+          # Report and write to summary.
+          python -Im coverage report --format=markdown --skip-empty --skip-covered >> "$GITHUB_STEP_SUMMARY"
+
+      - name: Upload coverage data
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          use_oidc: true
+
+
+  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.3 → napari_plugin_manager-0.1.5rc0}/.gitignore

@@ -24,6 +24,8 @@ var/
 .installed.cfg
 *.egg
 
+src/napari_plugin_manager/_version.py
+
 # 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.

{napari_plugin_manager-0.1.3 → napari_plugin_manager-0.1.5rc0}/.pre-commit-config.yaml

@@ -4,25 +4,25 @@ repos:
     hooks:
       - id: absolufy-imports
   - repo: https://github.com/hadialqattan/pycln
-    rev: v2.4.0
+    rev: v2.5.0
     hooks:
       - id: pycln
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.8.0
+    rev: 25.1.0
     hooks:
       - id: black
         pass_filenames: true
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.3
+    rev: v0.9.9
     hooks:
       - id: ruff
   - repo: https://github.com/seddonym/import-linter
-    rev: v2.0
+    rev: v2.2
     hooks:
     - id: import-linter
       stages: [manual]
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.29.2
+    rev: 0.31.2
     hooks:
       - id: check-github-workflows
 

{napari_plugin_manager-0.1.3 → napari_plugin_manager-0.1.5rc0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: napari-plugin-manager
-Version: 0.1.3
+Version: 0.1.5rc0
 Summary: Install plugins for napari, in napari.
 Author-email: napari team <napari-steering-council@googlegroups.com>
 License: BSD 3-Clause License
@@ -43,9 +43,10 @@ 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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
@@ -55,20 +56,21 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: Unix
 Classifier: Operating System :: MacOS
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: npe2
 Requires-Dist: qtpy
 Requires-Dist: superqt
 Requires-Dist: pip
+Requires-Dist: packaging
 Provides-Extra: dev
-Requires-Dist: PyQt5; extra == "dev"
+Requires-Dist: PyQt6; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
 Requires-Dist: flaky; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
-Requires-Dist: pytest-cov; extra == "testing"
 Requires-Dist: pytest-qt; extra == "testing"
 Requires-Dist: virtualenv; extra == "testing"
 Provides-Extra: docs
@@ -79,6 +81,7 @@ 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"
+Dynamic: license-file
 
 # napari-plugin-manager
 
@@ -186,6 +189,20 @@ a restart to be properly configured.
 
 ![Screenshot of the napari-plugin-manager showing the process of installing a plugin](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/install.png)
 
+### Installing a plugin via direct entry
+
+You can also install a napari plugin or any other package via the direct entry option. The following steps 
+correspond to the options and buttons located at the **bottom of the dialog**.
+
+1. You can type either the name of the package, a url to the resource or drag and drop a compressed file
+   of a previously downloaded package.
+2. Select the tool (`conda` or `pip`) by clicking on the arrow dorpdown of the `Install` button.
+3. Start the installation process by clicking on the `Install` button.
+
+You can cancel the process at any time by clicking the `Cancel all` button.
+
+![Screenshot of the napari-plugin-manager showing the direct entry options](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/direct-entry.png)
+
 ### Uninstalling a plugin
 
 To uninstall a plugin:
@@ -215,6 +232,24 @@ You can cancel the process at any time by clicking the `Cancel` button of each p
 
 ![Screenshot of the napari-plugin-manager showing the process of updating a plugin](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/update.png)
 
+### Export/Import plugins
+
+You can export the list of install plugins by clicking on the `Export` button located on the top right
+corner of the UI. This will prompt a dialog to select the location and name of the text file where
+the installed plugin list will be saved.
+
+The file is plain text and plugins are listed in the [requirements.txt](https://pip.pypa.io/en/stable/reference/requirements-file-format/) format:
+```
+plugin_name==0.1.2
+```
+
+This file can be shared and then imported by clicking on the `Import` button located on the top right
+corner of the UI. This will prompt a dialog to select the location of the text file to import.
+
+After selecting the file, the plugin manager will attempt to install all the listed plugins using the auto-detected default installer.
+
+![Screenshot of the napari-plugin-manager showing the process of import/export](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/import-export.png)
+
 ### Batch actions
 
 You don't need wait for one action to finish before you can start another one. You can add more

{napari_plugin_manager-0.1.3 → napari_plugin_manager-0.1.5rc0}/README.md

@@ -104,6 +104,20 @@ a restart to be properly configured.
 
 ![Screenshot of the napari-plugin-manager showing the process of installing a plugin](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/install.png)
 
+### Installing a plugin via direct entry
+
+You can also install a napari plugin or any other package via the direct entry option. The following steps 
+correspond to the options and buttons located at the **bottom of the dialog**.
+
+1. You can type either the name of the package, a url to the resource or drag and drop a compressed file
+   of a previously downloaded package.
+2. Select the tool (`conda` or `pip`) by clicking on the arrow dorpdown of the `Install` button.
+3. Start the installation process by clicking on the `Install` button.
+
+You can cancel the process at any time by clicking the `Cancel all` button.
+
+![Screenshot of the napari-plugin-manager showing the direct entry options](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/direct-entry.png)
+
 ### Uninstalling a plugin
 
 To uninstall a plugin:
@@ -133,6 +147,24 @@ You can cancel the process at any time by clicking the `Cancel` button of each p
 
 ![Screenshot of the napari-plugin-manager showing the process of updating a plugin](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/update.png)
 
+### Export/Import plugins
+
+You can export the list of install plugins by clicking on the `Export` button located on the top right
+corner of the UI. This will prompt a dialog to select the location and name of the text file where
+the installed plugin list will be saved.
+
+The file is plain text and plugins are listed in the [requirements.txt](https://pip.pypa.io/en/stable/reference/requirements-file-format/) format:
+```
+plugin_name==0.1.2
+```
+
+This file can be shared and then imported by clicking on the `Import` button located on the top right
+corner of the UI. This will prompt a dialog to select the location of the text file to import.
+
+After selecting the file, the plugin manager will attempt to install all the listed plugins using the auto-detected default installer.
+
+![Screenshot of the napari-plugin-manager showing the process of import/export](https://raw.githubusercontent.com/napari/napari-plugin-manager/main/images/import-export.png)
+
 ### Batch actions
 
 You don't need wait for one action to finish before you can start another one. You can add more

{napari_plugin_manager-0.1.3 → napari_plugin_manager-0.1.5rc0}/docs/developers/contributing.md

@@ -17,7 +17,7 @@ git clone https://github.com/your-username/napari-plugin-manager.git
 cd napari-plugin-manager
 ```
 
-Set the `upstream` remote to the base `napari` repository:
+Set the `upstream` remote to the base `napari-plugin-manager` repository:
 ```sh
 git remote add upstream https://github.com/napari/napari-plugin-manager.git
 ```
@@ -39,9 +39,9 @@ in your environment as follows:
 pre-commit install
 ```
 
-Upon committing, your code will be formatted and linted according to our [`ruff`
-configuration](https://github.com/napari/napari-plugin-manager/blob/main/pyproject.toml). To learn
-more, see [`ruff`'s documentation](https://docs.astral.sh/ruff/).
+Upon committing, your code will be formatted and linted according to our
+[`ruff` configuration](https://github.com/napari/napari-plugin-manager/blob/main/pyproject.toml).
+To learn more, see [`ruff`'s documentation](https://docs.astral.sh/ruff/).
 
 You can also execute `pre-commit` at any moment by running the following:
 

{napari_plugin_manager-0.1.3 → napari_plugin_manager-0.1.5rc0}/pyproject.toml

@@ -7,10 +7,10 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "napari_plugin_manager/_version.py"
+write_to = "src/napari_plugin_manager/_version.py"
 
 [tool.setuptools.packages.find]
-where = ["."]
+where = ["src"]
 include = ["napari_plugin_manager"]
 exclude = []
 namespaces = false  
@@ -33,9 +33,10 @@ classifiers = [
     "Programming Language :: C",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: Visualization",
     "Topic :: Scientific/Engineering :: Information Analysis",
@@ -46,12 +47,13 @@ classifiers = [
     "Operating System :: Unix",
     "Operating System :: MacOS"
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
   "npe2",
   "qtpy",
   "superqt",
-  "pip"
+  "pip",
+  "packaging",
 ]
 dynamic = [
   "version"
@@ -59,14 +61,14 @@ dynamic = [
 
 [project.optional-dependencies]
 dev = [
-  "PyQt5",
+  "PyQt6",
   "pre-commit",
 ]
 
 testing = [
+  "coverage",
   "flaky",
   "pytest",
-  "pytest-cov",
   "pytest-qt",
   "virtualenv"
 ]
@@ -85,7 +87,7 @@ docs = [
 homepage = "https://github.com/napari/napari-plugin-manager"
 
 [tool.black]
-target-version = ['py39', 'py310', 'py311']
+target-version = ['py310', 'py311', 'py312', 'py313']
 skip-string-normalization = true
 line-length = 79
 
@@ -98,6 +100,33 @@ ignore = [
 
 [tool.ruff]
 line-length = 79
+
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".mypy_cache",
+    ".pants.d",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "*vendored*",
+    "*_vendor*",
+]
+
+target-version = "py310"
+fix = true
+
+[tool.ruff.lint]
 select = [
     "E", "F", "W", #flake8
     "UP", # pyupgrade
@@ -121,6 +150,7 @@ select = [
     "ICN", # flake8-import-conventions
     "RUF", # ruff specyfic rules
 ]
+
 ignore = [
     "E501", "UP006", "TCH001", "TCH002", "TCH003",
     "A003", # flake8-builtins - we have class attributes violating these rule
@@ -133,31 +163,6 @@ ignore = [
 
 ]
 
-exclude = [
-    ".bzr",
-    ".direnv",
-    ".eggs",
-    ".git",
-    ".mypy_cache",
-    ".pants.d",
-    ".ruff_cache",
-    ".svn",
-    ".tox",
-    ".venv",
-    "__pypackages__",
-    "_build",
-    "buck-out",
-    "build",
-    "dist",
-    "node_modules",
-    "venv",
-    "*vendored*",
-    "*_vendor*",
-]
-
-target-version = "py38"
-fix = true
-
 [tool.ruff.per-file-ignores]
 "**/_tests/*.py" = ["B011", "INP001", "TRY301"]
 
@@ -208,3 +213,25 @@ check_untyped_defs = true
 # disallow_any_generics = true
 # no_implicit_reexport = true
 # disallow_untyped_defs = true
+
+
+[tool.coverage.run]
+omit = [
+  "src/napari_plugin_manager/_version.py",
+]
+source = ["src"]
+relative_files = true
+
+
+[tool.coverage.report]
+exclude_also = [
+  "raise NotImplementedError",
+]
+
+
+[tool.coverage.paths]
+source = [
+    "src/",
+    "*/src/",
+    "*\\src\\",
+]

napari_plugin_manager-0.1.5rc0/src/napari_plugin_manager/_tests/test_base_installer_process.py

@@ -0,0 +1,23 @@
+import pytest
+
+from napari_plugin_manager.base_qt_package_installer import (
+    AbstractInstallerTool,
+)
+
+
+def test_not_implemented_methods():
+    tool = AbstractInstallerTool('install', ['requests'])
+    with pytest.raises(NotImplementedError):
+        tool.executable()
+
+    with pytest.raises(NotImplementedError):
+        tool.arguments()
+
+    with pytest.raises(NotImplementedError):
+        tool.environment()
+
+    with pytest.raises(NotImplementedError):
+        tool.constraints()
+
+    with pytest.raises(NotImplementedError):
+        tool.available()