pluginify 0.0.0.post1.dev0__tar.gz

pluginify-0.0.0.post1.dev0/.github/workflows/generate-badges.yaml

@@ -0,0 +1,240 @@
+name: Nightly Badge Generation
+
+on:
+  schedule:
+    - cron: '0 2 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_SYSTEM_PYTHON: true
+
+jobs:
+  check-commits:
+    runs-on: ubuntu-latest
+    outputs:
+      has_new_commits: ${{ steps.check.outputs.has_new_commits }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Check for new commits in last 24 hours
+        id: check
+        run: |
+          COMMITS=$(git log --oneline --since="25 hours ago" --no-merges | grep -v "\[skip ci\]" | wc -l)
+          if [ "$COMMITS" -gt 0 ]; then
+            echo "has_new_commits=true" >> $GITHUB_OUTPUT
+            echo "Found $COMMITS new commits in the last 25 hours"
+          else
+            echo "has_new_commits=false" >> $GITHUB_OUTPUT
+            echo "No new commits in the last 25 hours"
+          fi
+
+  generate-badges:
+    needs: check-commits
+    if: needs.check-commits.outputs.has_new_commits == 'true'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: |
+          uv pip install -e .[doc,lint,test]
+          uv pip install pytest mypy ruff commitizen coverage genbadge[all]
+
+      - name: Create directories
+        run: |
+          mkdir -p .github/badges
+          mkdir -p reports
+
+      - name: Run pytest with coverage
+        id: pytest
+        continue-on-error: true
+        run: coverage run -m pytest --junitxml=reports/junit.xml
+
+      - name: Generate pytest badge
+        run: |
+          if [ -f reports/junit.xml ]; then
+            genbadge tests -i reports/junit.xml -o .github/badges/tests-badge.svg -n "tests"
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='tests', right_txt='error', color='red')
+          b.write_to('.github/badges/tests-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Generate coverage badge
+        run: |
+          if [ -f coverage.xml ]; then
+            genbadge coverage -i coverage.xml -o .github/badges/coverage-badge.svg -n "coverage"
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='coverage', right_txt='error', color='red')
+          b.write_to('.github/badges/coverage-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Run mypy
+        id: mypy
+        continue-on-error: true
+        run: mypy ./src --junit-xml reports/mypy.xml || true
+
+      - name: Generate mypy badge
+        run: |
+          if [ -f reports/mypy.xml ]; then
+            genbadge tests -i reports/mypy.xml -o .github/badges/mypy-badge.svg -n "mypy"
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='mypy', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/mypy-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Run ruff
+        id: ruff
+        continue-on-error: true
+        run: ruff check ./src --output-format=junit -o reports/ruff.xml || true
+
+      - name: Generate ruff badge
+        run: |
+          if [ -f reports/ruff.xml ] && [ -s reports/ruff.xml ]; then
+            if grep -q "<testcase" reports/ruff.xml; then
+              genbadge tests -i reports/ruff.xml -o .github/badges/ruff-badge.svg -n "ruff"
+            else
+              python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='ruff', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/ruff-badge.svg', use_shields=False)
+          "
+            fi
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='ruff', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/ruff-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Test install
+        id: install
+        continue-on-error: true
+        run: uv pip install -e . --reinstall
+
+      - name: Generate install badge
+        run: |
+          if [ "${{ steps.install.outcome }}" == "success" ]; then
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='install', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/install-badge.svg', use_shields=False)
+          "
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='install', right_txt='failing', color='red')
+          b.write_to('.github/badges/install-badge.svg', use_shields=False)
+          "
+          fi
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Run cspell
+        id: cspell
+        continue-on-error: true
+        run: npx cspell "./src/**/*" --no-progress
+
+      - name: Generate cspell badge
+        run: |
+          if [ "${{ steps.cspell.outcome }}" == "success" ]; then
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='cspell', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/cspell-badge.svg', use_shields=False)
+          "
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='cspell', right_txt='failing', color='red')
+          b.write_to('.github/badges/cspell-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Check commitizen
+        id: commitizen
+        continue-on-error: true
+        env:
+          COMMITIZEN_START_REV: "9d83e6984277ccbe6c5f6713f65b75a90e7c7e40"
+        run: cz check --rev-range ${{ env.COMMITIZEN_START_REV }}..HEAD
+
+      - name: Generate commitizen badge
+        run: |
+          if [ "${{ steps.commitizen.outcome }}" == "success" ]; then
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='commitizen', right_txt='passing', color='brightgreen')
+          b.write_to('.github/badges/commitizen-badge.svg', use_shields=False)
+          "
+          else
+            python -c "
+          from genbadge import Badge
+          b = Badge(left_txt='commitizen', right_txt='failing', color='red')
+          b.write_to('.github/badges/commitizen-badge.svg', use_shields=False)
+          "
+          fi
+
+      - name: Check for badge changes
+        id: badge_changes
+        run: |
+          git add .github/badges/*.svg
+          if git diff --cached --quiet; then
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "No badge changes detected"
+          else
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+            echo "Badge changes detected:"
+            git diff --cached --name-status .github/badges/
+          fi
+
+      - name: Commit and push badges
+        if: steps.badge_changes.outputs.has_changes == 'true'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git commit -m "chore: update badges [skip ci]"
+          git push
+
+      - name: Generate summary
+        run: |
+          echo "## Badge Generation Summary" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "| Check | Status |" >> $GITHUB_STEP_SUMMARY
+          echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
+          echo "| Pytest & Coverage | ${{ steps.pytest.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Mypy | ${{ steps.mypy.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Ruff | ${{ steps.ruff.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Install | ${{ steps.install.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| CSpell | ${{ steps.cspell.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "| Commitizen | ${{ steps.commitizen.outcome }} |" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "Badges committed: ${{ steps.badge_changes.outputs.has_changes }}" >> $GITHUB_STEP_SUMMARY

pluginify-0.0.0.post1.dev0/.github/workflows/lint-and-test.yaml

@@ -0,0 +1,119 @@
+name: CI
+
+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
+  COMMITIZEN_START_REV: "9d83e6984277ccbe6c5f6713f65b75a90e7c7e40"
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Single lint job — every hook runs as its own step so failures are visible
+  # ---------------------------------------------------------------------------
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # needed for commitizen rev-range
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+          cache: false
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Ruff (lint)
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: ruff-check --all-files
+
+      - name: Ruff (format)
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: ruff-format --all-files
+
+      - name: Blacken-docs
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: blacken-docs --all-files
+
+      - name: mdformat
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: mdformat --all-files
+
+      - name: actionlint
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: actionlint --all-files
+
+      - name: validate-pyproject
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: validate-pyproject --all-files
+
+      - name: yamlfmt
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: yamlfmt --all-files
+
+      - name: cspell
+        if: success() || failure()
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: cspell --all-files
+
+  # ---------------------------------------------------------------------------
+  # Single matrix job — install once, then run pytest + docs + mypy
+  # ---------------------------------------------------------------------------
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Install package with all extras
+        run: uv pip install -e .[doc,lint,test] pytest mypy
+
+      - name: Run pytest
+        run: python -m pytest
+
+      - name: Run mypy
+        if: (success() || failure()) && matrix.python-version == '3.13'
+        run: mypy ./src

pluginify-0.0.0.post1.dev0/.github/workflows/package-and-publish.yaml

@@ -0,0 +1,104 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+  # Allow manual trigger for testing the workflow
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_SYSTEM_PYTHON: true
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Build sdist and wheel
+  # ---------------------------------------------------------------------------
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Install build tools
+        run: uv pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: List built artifacts
+        run: ls -lh dist/
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  # ---------------------------------------------------------------------------
+  # Run the test suite against the built wheel (not the source tree)
+  # ---------------------------------------------------------------------------
+  test-built-package:
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Install wheel and test dependencies
+        shell: bash
+        run: |
+          uv pip install dist/*.whl
+          uv pip install pytest pytest-cov pytest-xdist pydantic
+
+      - name: Run tests
+        run: python -m pytest tests/ -v
+
+  # ---------------------------------------------------------------------------
+  # Publish to PyPI
+  # ---------------------------------------------------------------------------
+  publish-pypi:
+    needs: [build, test-built-package]
+    runs-on: ubuntu-latest
+    #if: github.event_name == 'release'
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

pluginify-0.0.0.post1.dev0/.github/workflows/status-check.yaml

@@ -0,0 +1,17 @@
+name: Require up-to-date branch
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  status-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: No-op status check
+        run: echo "No-op Actions workflow to allow enforcing up to date branches before merge"

pluginify-0.0.0.post1.dev0/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.

pluginify-0.0.0.post1.dev0/PKG-INFO

@@ -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
+```
+