pluginify 0.0.0.post1.dev0__py3-none-any.whl

pluginify/plugins/classes/data_modifiers/cuboid.py

@@ -0,0 +1,41 @@
+"""Cuboid data modifier plugin class.
+
+This is a 'dummy' plugin which is strictly used for testing pluginify.
+"""
+
+from pluginify.interfaces.class_based.data_modifiers import BaseDataModifierPlugin
+
+
+class CuboidDataModifierPlugin(BaseDataModifierPlugin):
+    """Cuboid data modifier class.
+
+    This is a 'dummy' plugin which is strictly used for testing pluginify.
+    """
+
+    name = "cuboid"
+    interface = "data_modifiers"
+    family = "standard"
+
+    def call(self, data, config):
+        """Modify the cuboid-like dataset using parameters from 'config'.
+
+        Parameters
+        ----------
+        data: xarray.Dataset
+            - The incoming xarray.Dataset to modify.
+        config: dict
+            - A dictionary representing the configuration plugin used to modify this
+              dataset.
+
+        Returns
+        -------
+        xarray.Dataset
+            - The modified dataset based on the parameters set in 'config'.
+        """
+        for md_key, md_val in config["spec"].items():
+            data[md_key] = md_val
+
+        return data
+
+
+PLUGIN_CLASS = CuboidDataModifierPlugin

pluginify/plugins/yaml/configs/stucco.yaml

@@ -0,0 +1,16 @@
+apiVersion: pluginify/v1
+interface: configs
+name: stucco
+family: standard
+docstring: |
+    Configuration plugin containing parameters needed to create a stucco product.
+
+    This is a 'dummy' plugin which is strictly used for testing pluginify.
+spec:
+    material: stucco
+    units: feet
+    dimensions:
+        height: 22
+        width: 36
+        depth: 18
+    shape: cuboid

pluginify/pydantic_models/v1/configs.py

@@ -0,0 +1,58 @@
+"""
+Pydantic model for pluginify configuration plugins.
+
+NOTE: these plugins are not intended to be used. They are just provided as an example to
+see how the plugin registry functions and for testing this package.
+"""
+
+from typing import Literal, Optional, Union
+
+from pydantic import BaseModel, Field
+
+
+class Dimensions(BaseModel):
+    """Model representing the dimensions field of a configuration plugin."""
+
+    y: Union[float, int] = Field(
+        ..., description="The height of the product.", alias="height"
+    )
+    x: Union[float, int] = Field(
+        ..., description="The width of the product.", alias="width"
+    )
+    z: Optional[Union[float, int]] = Field(
+        None, description="The depth of the product.", alias="depth"
+    )
+
+
+class ConfigSpec(BaseModel):
+    """Model for the spec of a configuration plugin."""
+
+    material: str = Field(..., description="The material of the product.")
+    units: Literal["inches", "centimeters", "feet", "meters", "kilometers", "miles"] = (
+        Field(..., description="The units of the product.")
+    )
+    dimensions: Dimensions = Field(..., description="The dimensions of the product.")
+    shape: str = Field(..., description="The shape of the product.")
+
+
+class ConfigPluginModel(BaseModel):
+    """Model for yaml configuration plugins.
+
+    Config plugins and all fields in those plugins are 'dummy' and strictly used for
+    testing purposes. For examples of real plugins which actually act upon data, see
+    https://github.com/NRLMMD-GEOIPS/geoips/tree/main/geoips/plugins.
+    """
+
+    apiVersion: str = Field(
+        "pluginify/v1",
+        description="The api version in which the plugin was implemented under.",
+    )
+    interface: str = Field(
+        ..., description="The interface which this plugin adheres to."
+    )
+    name: str = Field(..., description="The name of the plugin.")
+    family: str = Field(..., description="The family of the plugin.")
+    docstring: str = Field(
+        ..., description="A description of the plugin and what it does."
+    )
+    spec: ConfigSpec = Field(..., description="Specification of the product.")

pluginify/utils/__init__.py

@@ -0,0 +1,62 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Pluginify utility module."""
+
+from copy import deepcopy
+
+
+def merge_nested_dicts(dest, src, in_place=True, replace=False):
+    """Perform an in-place merge of src into dest.
+
+    Performs an in-place merge of src into dest while preserving any values that already
+    exist in dest.
+
+    Parameters
+    ----------
+    dest: dict
+        - The destination dictionary to merge to
+    src: dict
+        - The source dictionary to merge into dest
+    in_place: bool, default=True
+        - Whether or not to merge directly into dest or to create a deepcopy of dest
+          and return that as the final result. By default, this function will merge
+          directly into dest.
+    replace: boo, default=False
+        - Whether or not to override duplicate keys in src and dest with the contents of
+          src. By default, replace is set to false and overriding will not occur.
+    """
+    if not in_place:
+        final_dest = deepcopy(dest)
+    else:
+        final_dest = dest
+
+    # It will automatically replace ALL fields found in
+    # the original product spec and also found in the
+    # override with what is specified in the override
+    # in its entirety, without merging.  This is not
+    # terribly useful overall - we probably want this
+    # sort of capability in the end, but more flexible
+    # and able to be applied to only specific fields,
+    # etc.  This is a brute force method to at least
+    # allow overriding entire fields.
+    if replace:
+        for key in final_dest:
+            if key in src:
+                final_dest[key] = src[key]
+        return final_dest
+
+    try:
+        final_dest.update(src | final_dest)
+    except (AttributeError, TypeError):
+        return
+    try:
+        for key, val in final_dest.items():  # NOQA
+            try:
+                merge_nested_dicts(final_dest[key], src[key])
+            except KeyError:
+                pass
+    except AttributeError:
+        raise
+    if not in_place:
+        return final_dest

pluginify/utils/context_managers.py

@@ -0,0 +1,32 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
+"""Module for handling optional dependencies throughout pluginify."""
+
+import logging
+from contextlib import contextmanager
+import traceback
+
+LOG = logging.getLogger(__name__)
+
+
+@contextmanager
+def import_optional_dependencies(loglevel="info"):
+    """Attempt to import a package and log the event if the import fails.
+
+    Parameters
+    ----------
+    loglevel : str
+        Name of the log level to write to. May be any valid log level (e.g. debug, info,
+        etc.).
+    """
+    try:
+        yield None
+    except ImportError as err:
+        tb = traceback.extract_tb(err.__traceback__)
+        filename, lineno, _, _ = tb[-1]
+        err_str = f"Failed to import {err.name} at {filename}:{lineno}. "
+        err_str += "If you need it, install it."
+
+        getattr(LOG, loglevel)(err_str)
+        # print(err_str)

pluginify-0.0.0.post1.dev0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: pluginify
+Version: 0.0.0.post1.dev0
+Summary: Pluginify package
+License: LICENSE
+License-File: LICENSE
+Author: Evan Rose
+Requires-Python: >=3.11.0,<3.13.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: doc
+Requires-Dist: docstring_parser
+Requires-Dist: jsonschema (>4.18.0)
+Requires-Dist: lexeme-type
+Requires-Dist: platformdirs
+Requires-Dist: pydantic (>=2.10.0)
+Requires-Dist: pyyaml
+Requires-Dist: sphinxcontrib-typer ; extra == "doc"
+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.
+
+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
+acts as a configuration object for a class / module -based python plugin. The python
+based plugins are then responsible for reading, manipulating, or outputting a dataset
+in a certain format. For most python based plugins, we expect this dataset to be a valid
+xarray.DataTree object.
+
+No valid plugins should be stored in this package. Rather, this package contains all the
+functionality to register, retrieve, and create your plugin objects via a unified
+PluginRegistry class. This package can and is used alongside other packages such as
+[GeoIPS](https://github.com/NRLMMD-GEOIPS/geoips) to handle their plugin-based
+infrastructure.
+
+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 .
+```
+In the future:
+```bash
+    pip install pluginify
+```
+
+Use pluginify
+-------------
+```bash
+pluginify -h
+# Top level commands without additional args
+pluginify create
+# OR
+pluginify delete
+```
+

pluginify-0.0.0.post1.dev0.dist-info/RECORD

@@ -0,0 +1,22 @@
+pluginify/__init__.py,sha256=NvdicJtfy-dZZ8tWjR74lDBHGV6rlaH8pAJ7UHyTTog,391
+pluginify/_version.py,sha256=I_xg_zrKOMl6Y8jLXjH6TifTHdty9HEaI8c-DJniO18,237
+pluginify/commandline_typer.py,sha256=v9r7oBnD39pFLBqhoUNefGEwyRFCzDKpiPa3cvXXzCk,8676
+pluginify/config.py,sha256=co4HkXsOrA68M0PlRaUAhz5KMp5pa60ssb7DwLvUuxk,4894
+pluginify/create_plugin_registries.py,sha256=9NGFRzyZIaF7Mj1BMbNLTbyRVtnZWjmwSnCL0qnra_0,48494
+pluginify/errors.py,sha256=kkdipLfxvj8f-Pp53SD3RPnD9QS3samBLlQBjBskZP8,373
+pluginify/interfaces/__init__.py,sha256=XcPl52V8oMihP7NoRs_NgbiIvqoL3A4YeyfTOp3NqBA,329
+pluginify/interfaces/base.py,sha256=ubimAsOgAXCyhKhn40-a1HIfrjMPqHtKr4rBnwm645M,26724
+pluginify/interfaces/class_based/data_modifiers.py,sha256=p-d80oywjo9Rr6txowr1BIlg08qeOm3dAMm_4JQ0iH8,1072
+pluginify/interfaces/class_based_plugin.py,sha256=TMuJ2INaaFaUlxPX05L5r2gH3ISu1W_2qWllGA63oq4,8209
+pluginify/interfaces/yaml_based/configs.py,sha256=3U_nKCm2mIVfA_cRl-VUmu8JrQQQ3u24eshH46a9GI0,808
+pluginify/plugin_registry.py,sha256=yN8ooSHB7HfM31AQoeDUB7oJc87K7ZJHR_XllVr-bCM,40546
+pluginify/plugins/classes/data_modifiers/cuboid.py,sha256=WyvhPrRptpSHtPqeOdF1oiHm6zFwHahsLwNvsMdmQEE,1107
+pluginify/plugins/yaml/configs/stucco.yaml,sha256=OXLWzmmzxSAWs-MzSlmEa-OLGJzVJzrVQZwgGPL2jqE,376
+pluginify/pydantic_models/v1/configs.py,sha256=As15amNtdFwAobufh0d6mDlF3mMS23ThwTKQy9q25bc,2122
+pluginify/utils/__init__.py,sha256=gdy4E4yEI9lrHbWPeBn0Bspj7iz4z6r8BAjbmHf_hpM,2088
+pluginify/utils/context_managers.py,sha256=1-bREbijNNc5PrqMIihKqxlxNaK-YZ3hj5XGpHiYmfw,926
+pluginify-0.0.0.post1.dev0.dist-info/METADATA,sha256=YoQUcPZOkt58ozii6zhO33T9-N11vPIxl-uxXl1aWsU,2086
+pluginify-0.0.0.post1.dev0.dist-info/WHEEL,sha256=Vz2fHgx6HFtSwhs8KvkHLqH5Ea4w1_rner5uNVGCeIE,88
+pluginify-0.0.0.post1.dev0.dist-info/entry_points.txt,sha256=kCm7HOEEzSnPyDpy98W-LYYmlLYyTnRqOj40UqxX6-w,111
+pluginify-0.0.0.post1.dev0.dist-info/licenses/LICENSE,sha256=sIBqTiU78gw5bC9MZMySNxzCE7DIlOcDqUWdmflkDsY,7266
+pluginify-0.0.0.post1.dev0.dist-info/RECORD,,

pluginify-0.0.0.post1.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.2
+Root-Is-Purelib: true
+Tag: py3-none-any

pluginify-0.0.0.post1.dev0.dist-info/entry_points.txt

@@ -0,0 +1,6 @@
+[console_scripts]
+pluginify=pluginify.commandline_typer:main
+
+[pluginify.plugin_packages]
+pluginify=pluginify
+

pluginify-0.0.0.post1.dev0.dist-info/licenses/LICENSE

@@ -0,0 +1,128 @@
+NRL OPEN LICENSE AGREEMENT
+
+1. Scope and Applicability: This Agreement applies to Computer Software that
+is made available under this Agreement. By using, modifying, or disseminating
+the Computer Software, You accept the terms and conditions in this Agreement.
+Use, modification, and dissemination of the Computer Software is permitted
+only in accordance with the terms and conditions of this Agreement. No other
+rights or licenses to the Computer Software are granted. Unauthorized use,
+sale, conveyance, disposition, or modification of a Computer Software may
+result in civil penalties and/or criminal penalties under 18 U.S.C. § 641.
+
+
+2. For purposes of this Agreement, the following definitions apply:
+
+a. “Computer software” means computer programs, source code, source code
+listings, object code listings, design details, algorithms, processes,
+flow charts, formulae, and related material that would enable the software
+to be reproduced, recreated, or recompiled.
+
+b. “Derivative work” is a work based upon some or all of the Computer Software.
+
+c. “Unlimited rights” means rights to use, modify, reproduce, release,
+perform, display, or disclose, in whole or in part, in any manner and for
+any purpose whatsoever, and to have or authorize others to do so.
+
+d. “You” means yourself and any corporation, company, association, firm,
+partnership, society, and joint stock company to which you are an employee,
+volunteer, or an independent contractor performing services therefor.
+
+3. Use and Distribution License: The Government of the United States of
+America (“Government”) hereby authorizes You to use and modify the Computer
+Software for any purpose. The Government hereby authorizes You to
+redistribute the Computer Software, but only under the terms of this
+Agreement. You agree that any modifications to and derivative works of the
+Computer Software generated by You shall be distributed only under the terms
+of this Agreement. You shall provide a copy of this Agreement with any
+distribution of the Computer Software, or any modification to and derivative
+works of the Computer Software.
+
+4. Ownership: All Computer Software is property of the Government and under
+the custody and administration of the U.S. Naval Research Laboratory (NRL).
+Nothing in the Agreement shall be construed to constitute a sale, assignment,
+or transfer of ownership to You of the Computer Software.
+
+5. Markings: You shall not remove any copyright notices, disclaimers, notices
+of Government sponsorship and license rights, third-party licenses, and any
+other identifications, contained in the Computer Software or provided in a
+file accompanying the Computer Software, such as a license file.
+
+6. Header File Required: For source code provided under this Agreement, the
+header of each source file shall contain the following statement:
+
+!#######################################################################
+
+THIS SOURCE CODE IS PROPERTY OF THE GOVERNMENT OF THE UNITED STATES OF
+AMERICA. BY USING, MODIFYING, OR DISSEMINATING THIS SOURCE CODE, YOU ACCEPT
+THE TERMS AND CONDITIONS IN THE NRL OPEN LICENSE AGREEMENT. USE, MODIFICATION,
+AND DISSEMINATION ARE PERMITTED ONLY IN ACCORDANCE WITH THE TERMS AND
+CONDITIONS OF THE NRL OPEN LICENSE AGREEMENT. NO OTHER RIGHTS OR LICENSES
+ARE GRANTED. UNAUTHORIZED USE, SALE, CONVEYANCE, DISPOSITION, OR MODIFICATION
+OF THIS SOURCE CODE MAY RESULT IN CIVIL PENALTIES AND/OR CRIMINAL PENALTIES
+UNDER 18 U.S.C. § 641.
+
+!########################################################################
+
+7. Government Rights: In consideration of making the Computer Software
+available to You, You irrevocably grant the Government, at no cost, unlimited
+rights in any and all modifications to, and derivative works of, the Computer
+Software. Upon request, You shall deliver to NRL, or another Federal component
+or agency as NRL may designate, all modifications to and derivative works of
+the Computer Software generated by You or that are in Your possession.
+
+8. ALL MATERIAL IS PROVIDED “AS IS” AND WITHOUT ANY REPRESENTATION OR
+WARRANTY, EXPRESS OR IMPLIED, INCLUDING WITHOUT ANY PARTICULAR PURPOSE
+OR ANY WARRANTIES OF ACCURACY OR COMPLETENESS OR ANY WARRANTIES THAT THE
+USE OF THE COMPUTER SOFTWARE WILL NOT INFRINGE OR VIOLATE ANY PATENT OR
+OTHER PROPRIETARY RIGHTS OF ANY THIRD PARTY (WHETHER DIRECTLY OR INDIRECTLY).
+
+9. Notice: You shall provide prominent notice on any derivative work of the
+Computer Software, or in a file accompanying the Computer Software, that the
+Computer Software was developed in part or in whole by NRL.
+
+10. No Support. The Computer Software(s) is provided without any support or
+maintenance, and without any obligation to provide modifications,
+improvements, enhancements, or updates thereto. No oral or written
+information or advice given by Federal employees shall create a warranty
+or in any way modify this Agreement.
+
+11. Export Control: This Agreement does not authorize any disclosure, export,
+or deemed export of technical information, articles, or services, nor does it
+authorize or approve the use of any exemption to the export licensing
+requirements of the International Traffic in Arms Regulations (“ITAR”) or the
+Export Administration Regulations (“EAR”). You shall ensure full compliance
+with all applicable requirements and restrictions established in law and
+regulation pertaining to United States export controls including the Arms
+Export Control Act, the International Traffic in Arms Regulations, the Export
+Control Reform Act, the Export Administration Regulations, and the Atomic
+Energy Act.
+
+12. Termination: The Government, either through NRL or another Federal
+component or agency, may terminate this Agreement at any time. The Government
+rights under Section 7 shall survive termination.
+
+13. Liability: You shall be solely liable for all claims and/or damages which
+may arise from Your use, storage or disposal of the Computer Software under
+this Agreement. Nothing in this Agreement shall be construed as a waiver of
+the sovereign immunity of the United States.
+
+14. Indemnification: You agree on behalf of Yourself, and any successors in
+interest or assignees of You, to hold harmless and indemnify the United States
+from any claim for damages or injury to any person or property arising out of
+the provision of the Computer Software. This will include any costs relating
+to infringing a third party’s intellectual property rights.
+
+15. Governing Law & Jurisdiction. If a dispute, controversy, or claim relating
+to this Agreement shall arise, You agree to first attempt to settle such
+matter through informal dispute resolution. If any such matter cannot be
+resolved informally, applicable U.S. Federal laws shall govern this Agreement
+for all purposes.
+
+16. No Government Endorsement: You shall not make or include any statements
+that imply NRL or another component or agency of the Federal Government
+endorses You, Your work, or any product or service You offer.
+
+17. Severability. If any provision or term of this Agreement is held to be
+invalid by a court of competent jurisdiction, then such provision or term
+will be enforced to the maximum extent possible and the remaining terms of
+this Agreement will continue in full force and effect.