pluginify 0.1.0.post11.dev0__tar.gz → 1.0.0.post11.dev0__tar.gz

pluginify-1.0.0.post11.dev0/.github/workflows/deploy-docs.yaml

@@ -0,0 +1,32 @@
+name: Deploy docs
+
+# 1. Tag and Release - on merge of v*-version-release
+#    * Tag current version
+#    * Release just tagged version
+# 2. Package and Publish - on published release (from #1)
+#    * Build wheel
+#    * Publish to pypi
+# 3. Deploy docs - on published release (from #1)
+#    * pip install geoips
+#    * pip install plugin repo
+#    * build docs with geoips/docs/build_docs.sh
+#    * deploy docs with geoips/docs/deploy_pages.sh
+
+on:
+  # Triggers the workflow on published release
+  release:
+    types:
+      - published
+  # Allows run of this workflow manually from the Actions tab
+  # Must be merged to default before it will be available to manually run.
+  workflow_dispatch:
+
+jobs:
+  deploy-docs:
+    name: Deploy docs
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-deploy-docs.yaml@main
+    permissions:
+      contents: write
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

pluginify-1.0.0.post11.dev0/.github/workflows/integ_test.yaml

@@ -0,0 +1,25 @@
+name: Integration tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  workflow_dispatch:
+
+concurrency:
+  group: integ-test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  integ-test:
+    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.draft == false
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-ci.yaml
+    # reusable-ci's job requests these; a called workflow cannot exceed the caller.
+    permissions:
+      contents: read
+      packages: write
+    with:
+      geoips_image: "ghcr.io/nrlmmd-geoips/geoips:latest"
+      run_core_tests: true
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+      docker_token: ${{ secrets.DOCKER_TOKEN }}

pluginify-1.0.0.post11.dev0/.github/workflows/mypy.yaml

@@ -0,0 +1,39 @@
+name: mypy
+
+# Lint, unit tests and the geoips unit tests are in integ_test.yaml (geoips_ci's
+# reusable-ci). It does not type check, so mypy stays here.
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_SYSTEM_PYTHON: true
+
+jobs:
+  mypy:
+    continue-on-error: true
+    runs-on: ${{ vars.RUNNER }}
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e  # v6.8.0
+
+      - name: Install package
+        run: uv pip install -e ".[doc]" mypy
+
+      - name: Run mypy
+        run: mypy ./pluginify

pluginify-1.0.0.post11.dev0/.github/workflows/package-and-publish.yaml

@@ -0,0 +1,34 @@
+name: Package/publish
+
+# 1. Tag and Release - on merge of v*-version-release
+#    * Tag current version
+#    * Release just tagged version
+# 2. Package and Publish - on published release (from #1)
+#    * Build wheel
+#    * Publish to pypi
+# 3. Deploy docs - on published release (from #1)
+#    * pip install geoips
+#    * pip install plugin repo
+#    * build docs with geoips/docs/build_docs.sh
+#    * deploy docs with geoips/docs/deploy_pages.sh
+
+on:
+  # triggers the workflow on published release
+  release:
+    types:
+      - published
+  # allows run of this workflow manually from the actions tab
+  # must be merged to default before it will be available to manually run.
+  workflow_dispatch:
+
+jobs:
+  package-publish:
+    name: Package/publish
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-package-and-publish.yaml@main
+    permissions:
+      contents: read
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+      pypi_user: ${{ secrets.PYPI_USER }}
+      pypi_password: ${{ secrets.PYPI_PASSWORD }}

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/.github/workflows/status-check.yaml

@@ -2,6 +2,7 @@ name: Require up-to-date branch
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
   push:
     branches:
       - main
@@ -11,7 +12,8 @@ permissions:
 
 jobs:
   status-check:
-    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || github.event.pull_request.draft == false
+    runs-on: ${{ vars.RUNNER }}
     steps:
       - name: No-op status check
         run: echo "No-op Actions workflow to allow enforcing up to date branches before merge"

pluginify-1.0.0.post11.dev0/.github/workflows/tag-and-release.yaml

@@ -0,0 +1,27 @@
+name: Tag/release
+
+on:
+  # Triggers the workflow when pull request closed (either closed
+  # as non-planned, or actually approved and merged.)
+  pull_request:
+    types:
+      - closed
+    # You do not appear to be able to use variables in triggers
+    branches:
+      - main
+  # Allows run of this workflow manually from the Actions tab
+  # Must be merged to default branch before it will be available
+  # to manually run.
+  workflow_dispatch:
+
+jobs:
+  tag-release:
+    name: Tag/release
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-tag-and-release.yaml@main
+    # Only run this if the pull request was merged, not just closed.
+    if: github.event.pull_request.merged == true
+    permissions:
+      contents: write
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginify
-Version: 0.1.0.post11.dev0
+Version: 1.0.0.post11.dev0
 Summary: Pluginify package
 License: LICENSE
 License-File: LICENSE
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Provides-Extra: doc
 Requires-Dist: docstring_parser
 Requires-Dist: jsonschema (>4.18.0)
@@ -24,11 +25,12 @@ Requires-Dist: typer
 Project-URL: Repository, https://github.com/NRLMMD-GEOIPS/pluginify
 Description-Content-Type: text/markdown
 
-    # # # This source code is subject to the license referenced at
-    # # # https://github.com/NRLMMD-GEOIPS.
+```
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+```
 
-Pluginify
-=========
+# Pluginify
 
 This repository contains everything necessary to fully register YAML and python classes
 and/or modules as valid python plugin objects. A YAML-based plugin object essentially
@@ -43,21 +45,24 @@ PluginRegistry class. This package can and is used alongside other packages such
 [GeoIPS](https://github.com/NRLMMD-GEOIPS/geoips) to handle their plugin-based
 infrastructure.
 
-Install pluginify package
--------------------------
+## Install pluginify package
+
 Current status:
+
 ```bash
 git clone https://github.com/NRLMMD-GEOIPS/pluginify.git
 # cd to pluginify's top level dir
 pip install -e .
 ```
+
 OR
+
 ```bash
 pip install pluginify
 ```
 
-Use pluginify
--------------
+## Use pluginify
+
 ```bash
 pluginify -h
 # Top level commands without additional args

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/README.md

@@ -1,8 +1,9 @@
-    # # # This source code is subject to the license referenced at
-    # # # https://github.com/NRLMMD-GEOIPS.
+```
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+```
 
-Pluginify
-=========
+# Pluginify
 
 This repository contains everything necessary to fully register YAML and python classes
 and/or modules as valid python plugin objects. A YAML-based plugin object essentially
@@ -17,21 +18,24 @@ PluginRegistry class. This package can and is used alongside other packages such
 [GeoIPS](https://github.com/NRLMMD-GEOIPS/geoips) to handle their plugin-based
 infrastructure.
 
-Install pluginify package
--------------------------
+## Install pluginify package
+
 Current status:
+
 ```bash
 git clone https://github.com/NRLMMD-GEOIPS/pluginify.git
 # cd to pluginify's top level dir
 pip install -e .
 ```
+
 OR
+
 ```bash
 pip install pluginify
 ```
 
-Use pluginify
--------------
+## Use pluginify
+
 ```bash
 pluginify -h
 # Top level commands without additional args

pluginify-1.0.0.post11.dev0/docs/source/releases/1.0.0/1.0.0-no-bug-fixes-required-on-this-release.yaml

@@ -0,0 +1,17 @@
+documentation:
+- title: Add release note for version 1.19.0
+  description: |
+    Release note on release branch to force tag/release, package/publish,
+    and deploy docs.
+
+    Additionally add any updated files from geoips_ci/sync
+  files:
+    added:
+    - docs/source/releases/latest/1.19.0-release-note.yaml
+    modified:
+    - geoips_ci/sync updated files
+  date:
+    start: 2026-06-05
+    finish: 2026-06-05
+  related-issue:
+    internal: geoips#1067 - 1.19.0 updates

pluginify-1.0.0.post11.dev0/docs/source/releases/1.0.0/1.19.0-internal-release.yaml

@@ -0,0 +1,12 @@
+Release Process:
+- title: Add 1.19.0 release note
+  description: |
+    Currently tagged internal version 1.18.2.
+  files:
+    added:
+    - docs/source/releases/1.19.0/1.19.0-internal-release.yaml
+  related-issue:
+    internal: pluginify#1067 - 1.19.0 updates*
+  date:
+    start: 2026-05-26
+    finish: 2026-05-26

pluginify-1.0.0.post11.dev0/docs/source/releases/1.0.0/1.19.0-open-source-upload.yaml

@@ -0,0 +1,7 @@
+Release Updates - Open Source Upload:
+- title: Open source upload
+  description: "This repo updated with current geoips version release"
+  files:
+    modified:
+    - standard sync files
+    - release notes

pluginify-1.0.0.post11.dev0/docs/source/releases/1.0.0/1.19.0-patch-internal-use-vars-runner.yaml

@@ -0,0 +1,17 @@
+continuous integration:
+- title: 'Use vars.RUNNER for runners'
+  description: |
+    Ensure we are using standard vars.RUNNER for the new pluginify-specific workflows.
+    Eventually we will want to consolidate this CI with the standard actions in
+    geoips_ci, but for now at least use vars.RUNNER.
+  files:
+    added: []
+    modified:
+    - '.github/workflows/generate-badges.yaml'
+    - '.github/workflows/lint-and-test.yaml'
+    deleted: []
+    moved: []
+  date:
+    start: 2026-05-26
+    finish: 2026-05-26
+

pluginify-1.0.0.post11.dev0/docs/source/releases/1.0.0/module-to-class-updates.yaml

@@ -0,0 +1,12 @@
+bug fix:
+- title: 'Fix bug where non-plugin modules are treated like plugins during registry initialization'
+  description: |
+    In GeoIPS 1342 we converted nearly all of the module-based plugins to true
+    class-based plugins. In doing so I discovered a bug where non-plugin modules living
+    in the geoips/plugins/classes/.../ directory caused errors when trying to build
+    the plugin registry. To fix this, I've added a check to see if a module has an
+    'interface' attribute set to None. If that condition is met, then just ignore the
+    module and continue to the next potential plugin.
+  files:
+    modified:
+      - pluginify/create_plugin_registries.py

pluginify-1.0.0.post11.dev0/docs/source/releases/latest/atomic-registry-writes.yaml

@@ -0,0 +1,22 @@
+bug fix:
+- title: 'Write plugin registries atomically'
+  description: |
+    Plugin registries were rewritten in place, so another process reading a
+    registry at the same time (for example parallel pytest-xdist workers, one of
+    them rebuilding the registries) could read an empty or partial file and fail
+    with ``JSONDecodeError``. Registries are now written to a temporary file in
+    the same directory and moved into place with ``os.replace``.
+  files:
+    deleted:
+    - ''
+    modified:
+    - 'pluginify/create_plugin_registries.py'
+    - 'tests/unit_tests/plugin_registries/test_plugin_registries.py'
+    added:
+    - ''
+  related-issue:
+    number: null
+    repo_url: 'https://github.com/NRLMMD-GEOIPS/pluginify'
+  date:
+    start: 2026-10-01
+    finish: 2026-10-01

pluginify-1.0.0.post11.dev0/docs/source/releases/latest/ignore-files-in-utils-directories.yaml

@@ -0,0 +1,17 @@
+bug fix:
+- title: 'Force ignore files in directories named */utils/'
+  description: 'Force ignore files in directories named */utils/'
+  files:
+    deleted:
+    - ''
+    modified:
+    - 'pluginify/create_plugin_registries.py'
+    - 'tests/unit_tests/plugin_registries/test_plugin_registries.py'
+    added:
+    - ''
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: 2026-07-12
+    finish: 2026-07-12

pluginify-1.0.0.post11.dev0/docs/source/releases/latest/use-geoips-ci.yaml

@@ -0,0 +1,32 @@
+continuous integration:
+- title: 'Use the standard GeoIPS CI from geoips_ci'
+  description: |
+    Run geoips_ci's reusable-ci on pull requests, like geoips and the plugin
+    repositories: geoips' lint (flake8, black, bandit), pluginify's unit tests, and
+    geoips' unit tests against the pluginify branch, in the geoips:latest image.
+    Remove the code-quality and nightly badge workflows and the unused badges; mypy
+    keeps its own workflow, since reusable-ci does not type check. Skip draft pull
+    requests in the status check, like geoips.
+  files:
+    deleted:
+    - '.github/badges/coverage-badge.svg'
+    - '.github/badges/cspell-badge.svg'
+    - '.github/badges/install-badge.svg'
+    - '.github/badges/mypy-badge.svg'
+    - '.github/badges/ruff-badge.svg'
+    - '.github/badges/tests-badge.svg'
+    - '.github/workflows/code-quality.yaml'
+    - '.github/workflows/generate-badges.yaml'
+    modified:
+    - '.github/workflows/status-check.yaml'
+    - 'docs/source/releases/latest/ignore-files-in-utils-directories.yaml'
+    added:
+    - '.github/workflows/integ_test.yaml'
+    - '.github/workflows/mypy.yaml'
+    - 'docs/source/releases/latest/use-geoips-ci.yaml'
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: 2026-10-20
+    finish: 2026-10-20

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/_version.py

@@ -3,5 +3,5 @@
 
 # DO NOT EDIT
 # managed by poetry-dynamic-versioning
-__version__ = "0.1.0.post11.dev0"
-__version_tuple__ = (0, 1, 0, "post11", "dev0")
+__version__ = "1.0.0.post11.dev0"
+__version_tuple__ = (1, 0, 0, "post11", "dev0")

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/commandline_typer.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Commandline module for Pluginify.
 
 Supports two main commands, `pluginify create` and `pluginify delete` as well as
@@ -140,7 +143,6 @@ class DocstringTyper(typer.Typer):
             new_params = []
 
             for name, param in sig.parameters.items():
-
                 default = param.default
                 help_text = param_help.get(name)
 
@@ -155,7 +157,7 @@ class DocstringTyper(typer.Typer):
 
                 # Optional arguments
                 short = f"-{name[0]}"
-                long = f"--{name.replace('_','-')}"
+                long = f"--{name.replace('_', '-')}"
 
                 option = typer.Option(default, short, long, help=help_text)
 

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/config.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Module containing configuration variables needed for pluginify to run."""
 
 
@@ -58,7 +61,6 @@ def _env_to_variable(name, default):
     env_val = getenv(name)
 
     if env_val:
-
         if name == "PLUGINIFY_REGISTRY_DIRECTORY":
             return Path(env_val)
         elif name == "PLUGINIFY_REBUILD_REGISTRIES":

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/create_plugin_registries.py

@@ -17,7 +17,7 @@ import logging
 from importlib import metadata, resources, util, import_module
 from inspect import signature
 import json
-from os import makedirs, remove
+from os import getpid, makedirs, remove, replace
 from os.path import (
     basename,
     dirname,
@@ -317,14 +317,24 @@ def write_registered_plugins(pkg_dir, plugins, save_type):
     """
     if save_type == "yaml":
         reg_plug_abspath = os_join(pkg_dir, "registered_plugins.yaml")
-        with open(reg_plug_abspath, "w") as plugin_registry:
-            LOG.info("Writing %s", reg_plug_abspath)
-            yaml.safe_dump(plugins, plugin_registry, default_flow_style=False)
     else:
         reg_plug_abspath = os_join(pkg_dir, "registered_plugins.json")
-        with open(reg_plug_abspath, "w") as plugin_registry:
-            LOG.info("Writing %s", reg_plug_abspath)
-            json.dump(plugins, plugin_registry, indent=4)
+    LOG.info("Writing %s", reg_plug_abspath)
+    # Write to a temporary file and move it into place, so that other processes
+    # reading the registry (for example parallel test workers) never see a
+    # partially written file.
+    tmp_abspath = f"{reg_plug_abspath}.{getpid()}.tmp"
+    try:
+        with open(tmp_abspath, "w") as plugin_registry:
+            if save_type == "yaml":
+                yaml.safe_dump(plugins, plugin_registry, default_flow_style=False)
+            else:
+                json.dump(plugins, plugin_registry, indent=4)
+        replace(tmp_abspath, reg_plug_abspath)
+    except BaseException:
+        if exists(tmp_abspath):
+            remove(tmp_abspath)
+        raise
 
 
 def create_plugin_registries(plugin_packages, save_type, namespace):
@@ -934,6 +944,15 @@ def add_class_plugin(package, relpath, plugins):
         # __version.py, etc.
         return error_message
 
+    if "utils" in Path(relpath).parts:
+        # Ignore helper modules that live under plugin trees. These files are not
+        # plugins and should not be imported or validated for PLUGIN_CLASS.
+        LOG.info(
+            f"Skipping module at relpath {relpath} from {package}, "
+            "found under a utils directory"
+        )
+        return error_message
+
     module_name = splitext(basename(relpath))[0]
     # We need the full path to the module in order
     # for relative imports to work within modules.
@@ -957,6 +976,18 @@ def add_class_plugin(package, relpath, plugins):
                          at relpath '{relpath}'\n"""
         return error_message
 
+    # If interface is None, then legitimately skip the module.
+    # We want to skip this first, before we test anything else.
+    # If it is not a plugin, we don't care if there are other
+    # errors in it at this stage (ie, avoid unnecessary unrelated
+    # catastrophic failures)
+    if hasattr(module, "interface") and module.interface is None:
+        LOG.info(
+            f"Skipping module '{module_name}' from '{package}', "
+            "interface_name is 'None'"
+        )
+        return error_message
+
     # We've encountered a truly 'class-based' plugin. I.e. we don't need to generate
     # the plugin object from the module itself. Collect metadata from this plugin
     # in a different fashion to what we've done previously.

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/interfaces/__init__.py

@@ -1,7 +1,10 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Initialization module for pluginify interfaces."""
 
-from pluginify.interfaces.class_based.data_modifiers import data_modifiers
-from pluginify.interfaces.yaml_based.configs import configs
+from pluginify.interfaces.class_based.data_modifiers import data_modifiers  # noqa: F401
+from pluginify.interfaces.yaml_based.configs import configs  # noqa: F401
 
 class_based_interfaces = ["data_modifiers"]
 yaml_based_interfaces = ["configs"]

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/interfaces/base.py

@@ -35,7 +35,7 @@ class BaseInterface(abc.ABC):
     import pluginify.plugin_registry as plugin_registry_module
 
     name = "BaseInterface"
-    interface_type = None  # This is set by child classes
+    interface_type: str = ""  # This is set by child classes
     rebuild_registries = REBUILD_REGISTRIES
     # Setting this attribute at the top level so it can be used by all methods.
     # This can be overridden by setting them in child interface classes
@@ -375,7 +375,7 @@ class BaseClassInterface(BaseInterface):
 
     interface_type = "class_based"
     name = "BaseClassInterface"
-    required_args = {}
+    required_args: dict[str, list[str]] = {}
 
     def __repr__(self):
         """Plugin interface repr method."""

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/interfaces/class_based/data_modifiers.py

@@ -32,7 +32,7 @@ class DataModifiersInterface(BaseClassInterface):
         "standard": ["data", "config"],
     }
 
-    required_kwargs = {"standard": []}
+    required_kwargs: dict[str, list[str]] = {"standard": []}
 
 
 data_modifiers = DataModifiersInterface()

{pluginify-0.1.0.post11.dev0 → pluginify-1.0.0.post11.dev0}/pluginify/interfaces/class_based_plugin.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Implements a base class for class-based plugins.
 
 The base class implemented here would expose the call signature of the child plugin
@@ -72,6 +75,7 @@ class BaseClassPlugin(ABC):
     # If no family is provided, just assume it works with DT
     data_tree = False
     required_attributes = ["interface", "family", "name"]
+    __plugin_abstract__: bool = False
 
     def _check_interface_attribute(cls):
         """Check the validity of the 'interface' attribute.
@@ -196,15 +200,15 @@ class BaseClassPlugin(ABC):
         if "__call__" in cls.__dict__:
             raise TypeError(f"{cls.__name__} cannot override __call__")
 
-        try:
-            call_method = cls.__dict__.get("call")
-        except AttributeError:
+        if "call" not in cls.__dict__:
             raise TypeError(f"{cls.__name__} must implement call()")
+        call_method = cls.__dict__["call"]
 
-        @functools.wraps(call_method)
+        @functools.wraps(call_method)  # type: ignore[arg-type]
         def _call(self, data=None, *args, **kwargs):
             return cls._invoke(self, data, *args, **kwargs)
 
-        _call.__signature__ = inspect.signature(call_method)  # mirror only call()
+        call_sig = inspect.signature(call_method)
+        _call.__signature__ = call_sig  # type: ignore[attr-defined]
         _call.__annotations__ = getattr(call_method, "__annotations__", {})
-        cls.__call__ = _call
+        cls.__call__ = _call  # type: ignore[method-assign]