lockss-turtles 0.5.0.dev3__tar.gz → 0.6.0__tar.gz

lockss_turtles-0.6.0/CHANGELOG.rst

@@ -0,0 +1,200 @@
+=============
+Release Notes
+=============
+
+-----
+0.6.0
+-----
+
+Released: 2025-10-23
+
+*  **Changes**
+
+   *  The configuration directory for Turtles in ``$XDG_CONFIG_HOME`` (by default ``$HOME/.config`` which is typically ``/home/$USER/.config``), ``/usr/local/share``, and ``/etc`` is now called ``lockss-turtles`` instead of ``lockss.turtles``.
+
+   *  Some long options have been renamed (the corresponding short options remain unchanged):
+
+      .. list-table::
+         :header-rows: 1
+
+         *  *  Short option
+            *  Long option, version 0.5.0
+            *  Long option, version 0.6.0
+         *  *  ``-i``
+            *  ``--identifier``
+            *  ``--plugin-identifier``
+         *  *  ``-I``
+            *  ``--identifiers``
+            *  ``--plugin-identifiers``
+         *  *  ``-j``
+            *  ``--jar``
+            *  ``--plugin-jar``
+         *  *  ``-J``
+            *  ``--jars``
+            *  ``--plugin-jars``
+         *  *  ``-l``
+            *  ``--layer``
+            *  ``--plugin-registry-layer``
+         *  *  ``-L``
+            *  ``--layers``
+            *  ``--plugin-registry-layers``
+         *  *  n/a
+            *  ``--password``
+            *  ``--plugin-signing-password``
+
+   *  Some short options have been renamed (the corresponding long options remain unchanged):
+
+      .. list-table::
+         :header-rows: 1
+
+         *  *  Long option
+            *  Short option, version 0.5.0
+            *  Short option, version 0.6.0
+         *  *  ``--plugin-registry-catalog``
+            *  ``-r``
+            *  ``-R``
+         *  *  ``--plugin-set-catalog``
+            *  ``-s``
+            *  ``-S``
+
+   *  Bare arguments are no longer allowed and treated as plugin identifiers or plugin JARs; all plugin identifiers must be specified via ``--plugin-identifier/-i`` or ``--plugin-identifiers/-I`` options and all plugin JARS via ``--plugin-jar/-j`` or ``--plugin-jars/-J`` options.
+
+   *  The ``usage`` command has been removed.
+
+*  **Features**
+
+   *  New options have been added:
+
+      .. list-table::
+         :header-rows: 1
+
+         *  *  Long option
+            *  Short option
+         *  *  ``--plugin-registry``
+            *  ``-r``
+         *  *  ``--plugin-set``
+            *  ``-s``
+
+   *  Options that read YAML files no longer expect each file to contain a single YAML configuration object, which must be of the kind they target; they now read all YAML configuration objects in each file, loading all the ones with the right kind and ignoring all the others with the other kinds. This applies to existing options ``--plugin-registry-catalog``/``-R`` and ``--plugin-set-catalog``/``-S``, and new options ``--plugin-registry``/``-r`` and ``--plugin-set``/``-s``.
+
+   *  In YAML files, values that are paths can now all be either relative with respect to the enclosing file or absolute.
+
+   *  Now using Pydantic for configuration objects instead of maintaining JSON Schema instances.
+
+   *  Now using type hinting throughout.
+
+   *  Now using *lockss-pybasic* and *pydantic-argparse* internally.
+
+   *  `Turtles documentation <https://docs.lockss.org/en/latest/software/turtles>`_ is now on the `LOCKSS Documentation Portal <https://docs.lockss.org/>`_.
+
+-----
+0.5.0
+-----
+
+Released: 2024-09-04
+
+*  **Features**
+
+   *  ``AntPluginSet``: also include plugin auxiliary packages (``plugin_aux_packages``).
+
+-----
+0.4.0
+-----
+
+Released: 2023-05-17
+
+*  **Features**
+
+   *  ``directory`` plugin registry layout now has the same file naming convention option as ``rcs``.
+
+   *  New ``directory``/``rcs`` file naming convention ``underscore``: replace ``.`` in the plugin identifier by ``_`` and add ``.jar``.
+
+   *  CLI improvements.
+
+*  **Changes**
+
+   *  The ``--output-format`` option is now only available in the context of commands where it makes sense.
+
+-----
+0.3.1
+-----
+
+Released: 2023-03-07
+
+*  **Bug Fixes**
+
+   *  Fixed use of the ``importlib.resources`` library.
+
+-----
+0.3.0
+-----
+
+Released: 2023-03-07
+
+*  **Features**
+
+   *  Completely refactored to be in the package ``lockss.turtles``.
+
+   *  Using Poetry to make uploadable to and installable from PyPI as `lockss-turtles <https://pypi.org/project/lockss-turtles>`_. Removed the requirements file.
+
+   *  Validate the various YAML objects (like a ``PluginSet``) against a `JSON Schema <https://json-schema.org/>`_.
+
+*  **Changes**
+
+   *  Temporarily disabled the ``analyze-registry`` command.
+
+   *  ``$XDG_CONFIG_HOME/turtles`` (by default ``$HOME/.config/turtles``) is now ``$XDG_CONFIG_HOME/lockss.turtles`` (by default ``$HOME/.config/lockss.turtles``) or ``/etc/lockss.turtles`` (formerly ``turtles``).
+
+   *  ``settings.yaml`` is now ``plugin-signing.yaml`` and its ``kind`` is now ``PluginSigning``. The corresponding command line option ``--settings`` is now ``--plugin-signing``.
+
+   *  ``plugin-sets.yaml``, its kind ``PluginSets``, its key ``plugin-sets``, and the command line option ``--plugin-sets`` are now ``plugin-set-catalog.yaml``, ``PluginSetCatalog``, ``plugin-set-files`` and ``--plugin-set-catalog``, respectively. The builder ``options`` key is deprecated.
+
+   *  ``plugin-registries.yaml``, its kind ``PluginRegistries``, its key ``plugin-registries``, and the command line option ``--plugin-registries`` are now ``plugin-registry-catalog.yaml``, ``PluginRegistryCatalog``, ``plugin-registry-files`` and ``--plugin-registry-catalog``, respectively. The ``file-naming-convention`` key is now directly under ``layout`` and the value ``full`` is now ``identifier``. The layout ``options`` key is deprecated.
+
+-----
+0.2.0
+-----
+
+Released: 2022-10-26
+
+*  **Features**
+
+   *  ``MavenPluginSet``, for Maven projects inheriting from ``org.lockss:lockss-plugins-parent-pom``.
+
+   *  ``RcsPluginRegistry``: file naming convention layout option.
+
+   *  Tabular output now includes the plugin version.
+
+*  **Bug Fixes**
+
+   *  ``AntPluginSet``: run ``ant load-plugins`` before building plugins.
+
+-----
+0.1.1
+-----
+
+Released: 2022-10-23
+
+*  **Bug Fixes**
+
+   *  ``RcsPluginRegistry``: Better handle incompletely managed RCS areas.
+
+   *  ``DirectoryPluginRegistry``: Better file handling with ``cp``.
+
+-----
+0.1.0
+-----
+
+Released: 2022-10-10
+
+*  **Features**
+
+   *  Initial release.
+
+   *  ``AntPluginSet``, based on the classic ``lockss-daemon`` Ant builder.
+
+   *  ``DirectoryPluginRegistry``, for a simple layout.
+
+   *  ``RcsPluginRegistry``, based on the classic RCS layout.
+
+   *  Tabular output by `tabulate <https://pypi.org/project/tabulate/>`_.

{lockss_turtles-0.5.0.dev3 → lockss_turtles-0.6.0}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University
+Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

lockss_turtles-0.6.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.3
+Name: lockss-turtles
+Version: 0.6.0
+Summary: Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries
+License: BSD-3-Clause
+Author: Thib Guicherd-Callin
+Author-email: thib@cs.stanford.edu
+Maintainer: Thib Guicherd-Callin
+Maintainer-email: thib@cs.stanford.edu
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Archiving
+Classifier: Topic :: Utilities
+Requires-Dist: exceptiongroup (>=1.3.0,<1.4.0)
+Requires-Dist: java-manifest (>=1.1.0,<1.2.0)
+Requires-Dist: lockss-pybasic (>=0.1.1,<0.2.0)
+Requires-Dist: pydantic (>=2.11.0,<2.12.0)
+Requires-Dist: pyyaml (>=6.0.0,<6.1.0)
+Requires-Dist: xdg (>=6.0.0,<6.1.0)
+Project-URL: Documentation, https://docs.lockss.org/en/latest/software/turtles
+Project-URL: Repository, https://github.com/lockss/lockss-turtles
+Project-URL: changelog, https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst
+Project-URL: issues, https://github.com/lockss/lockss-turtles/issues
+Description-Content-Type: text/x-rst
+
+=======
+Turtles
+=======
+
+.. |RELEASE| replace:: 0.6.0
+.. |RELEASE_DATE| replace:: 2025-10-23
+.. |TURTLES| replace:: **Turtles**
+
+.. image:: https://assets.lockss.org/images/logos/turtles/turtles_128x128.png
+   :alt: Turtles logo
+   :align: right
+
+|TURTLES| is a command line tool and Python library to manage LOCKSS plugin sets and LOCKSS plugin registries.
+
+:Latest release: |RELEASE| (|RELEASE_DATE|)
+:Documentation: https://docs.lockss.org/en/latest/software/turtles
+:Release notes: `CHANGELOG.rst <https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst>`_
+:License: `LICENSE <https://github.com/lockss/lockss-turtles/blob/main/LICENSE>`_
+:Repository: https://github.com/lockss/lockss-turtles
+:Issues: https://github.com/lockss/lockss-turtles/issues
+
+----
+
+Quick Start::
+
+   # Install with pipx
+   pipx install lockss-turtles
+
+   # Verify installation and discover all the commands
+   turtles --help
+
+

lockss_turtles-0.6.0/README.rst

@@ -0,0 +1,31 @@
+=======
+Turtles
+=======
+
+.. |RELEASE| replace:: 0.6.0
+.. |RELEASE_DATE| replace:: 2025-10-23
+.. |TURTLES| replace:: **Turtles**
+
+.. image:: https://assets.lockss.org/images/logos/turtles/turtles_128x128.png
+   :alt: Turtles logo
+   :align: right
+
+|TURTLES| is a command line tool and Python library to manage LOCKSS plugin sets and LOCKSS plugin registries.
+
+:Latest release: |RELEASE| (|RELEASE_DATE|)
+:Documentation: https://docs.lockss.org/en/latest/software/turtles
+:Release notes: `CHANGELOG.rst <https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst>`_
+:License: `LICENSE <https://github.com/lockss/lockss-turtles/blob/main/LICENSE>`_
+:Repository: https://github.com/lockss/lockss-turtles
+:Issues: https://github.com/lockss/lockss-turtles/issues
+
+----
+
+Quick Start::
+
+   # Install with pipx
+   pipx install lockss-turtles
+
+   # Verify installation and discover all the commands
+   turtles --help
+

lockss_turtles-0.6.0/pyproject.toml

@@ -0,0 +1,86 @@
+# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. 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.
+#
+# 3. 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]
+name = "lockss-turtles"
+version = "0.6.0" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+description = "Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin registries"
+license = { text = "BSD-3-Clause" }
+readme = "README.rst"
+requires-python = ">=3.9,<4.0"
+authors = [
+    { name = "Thib Guicherd-Callin",  email = "thib@cs.stanford.edu" },
+]
+maintainers = [
+    { name = "Thib Guicherd-Callin",  email = "thib@cs.stanford.edu" }
+]
+dependencies = [
+    "exceptiongroup (>=1.3.0,<1.4.0)",
+    "java-manifest (>=1.1.0,<1.2.0)",
+    "lockss-pybasic (>=0.1.1,<0.2.0)",
+    "pyyaml (>=6.0.0,<6.1.0)",
+    "xdg (>=6.0.0,<6.1.0)",
+    "pydantic (>=2.11.0,<2.12.0)",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Framework :: Pydantic :: 2",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: System :: Archiving",
+    "Topic :: Utilities",
+]
+
+# See https://docs.pypi.org/project_metadata/
+[project.urls]
+changelog = "https://github.com/lockss/lockss-turtles/blob/main/CHANGELOG.rst"
+documentation = "https://docs.lockss.org/en/latest/software/turtles"
+issues = "https://github.com/lockss/lockss-turtles/issues"
+repository = "https://github.com/lockss/lockss-turtles"
+
+[tool.poetry]
+include = [
+    "CHANGELOG.rst",
+    "LICENSE",
+    "README.rst",
+]
+packages = [
+    { include = "lockss", from = "src" },
+    { include = "unittest", from = "tests" },
+]
+
+[tool.poetry.scripts]
+turtles = 'lockss.turtles.cli:main'
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

lockss_turtles-0.6.0/src/lockss/turtles/__init__.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+
+"""
+Library and command line tool to manage LOCKSS plugin sets and LOCKSS plugin
+registries.
+"""
+
+#: This package's version.
+__version__ = '0.6.0'
+
+#: This package's copyright.
+__copyright__ = '''
+Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
+'''.strip()
+
+#: This package's license.
+__license__ = __copyright__ + '\n\n' + '''
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. 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.
+
+3. 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.
+'''.strip()

{lockss_turtles-0.5.0.dev3 → lockss_turtles-0.6.0}/src/lockss/turtles/__main__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University
+# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -28,6 +28,10 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-import lockss.turtles.cli
+"""
+Entry point for the ``lockss.turtles`` module.
+"""
 
-lockss.turtles.cli.main()
+from lockss.turtles.cli import main
+
+main()