lockss-turtles 0.6.0.dev21__tar.gz → 0.6.0.dev23__tar.gz

{lockss_turtles-0.6.0.dev21 → lockss_turtles-0.6.0.dev23}/CHANGELOG.rst

@@ -8,33 +8,82 @@ Release Notes
 
 Released: ?
 
+*  **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**
 
-   *  Now using type hinting throughout.
+   *  New options have been added:
 
-   *  Now using *lockss-pybasic* and *pydantic-argparse* internally.
+      .. list-table::
+         :header-rows: 1
 
-*  **Changes**
+         *  *  Long option
+            *  Short option
+         *  *  ``--plugin-registry``
+            *  ``-r``
+         *  *  ``--plugin-set``
+            *  ``-s``
 
-   *  The configuration directory for Turtles in ``$XDG_CONFIG_HOME`` (by default ``$HOME/.config``), ``/usr/local/share``, and ``/etc`` is now called ``lockss-turtles`` instead of ``lockss.turtles``.
+   *  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``.
 
-   *  Some long options have been renamed (the short options remain unchanged):
+   *  Now using Pydantic for configuration objects instead of maintaining JSON Schema instances.
 
-      ============ ================= =============
-      Short option Version 0.5.0     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``
-      ============ ================= =============
+   *  Now using type hinting throughout.
 
-   *  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.
+   *  Now using *lockss-pybasic* and *pydantic-argparse* internally.
 
-   *  The ``usage`` command has been removed.
+   *  `Turtles documentation <https://docs.lockss.org/en/latest/software/turtles>`_ is now on the `LOCKSS Documentation Portal <https://docs.lockss.org/>`_.
 
 -----
 0.5.0

lockss_turtles-0.6.0.dev23/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.3
+Name: lockss-turtles
+Version: 0.6.0.dev23
+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.0,<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-dev23 NOT YET RELEASED
+.. |RELEASE_DATE| replace:: NOT YET RELEASED
+.. |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.dev23/README.rst

@@ -0,0 +1,31 @@
+=======
+Turtles
+=======
+
+.. |RELEASE| replace:: 0.6.0-dev23 NOT YET RELEASED
+.. |RELEASE_DATE| replace:: NOT YET RELEASED
+.. |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.dev21 → lockss_turtles-0.6.0.dev23}/pyproject.toml

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-turtles"
-version = "0.6.0-dev21" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.6.0-dev23" # 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"

{lockss_turtles-0.6.0.dev21 → lockss_turtles-0.6.0.dev23}/src/lockss/turtles/__init__.py

@@ -6,7 +6,7 @@ registries.
 """
 
 #: This package's version.
-__version__ = '0.6.0-dev21'
+__version__ = '0.6.0-dev23'
 
 #: This package's copyright.
 __copyright__ = '''

{lockss_turtles-0.6.0.dev21 → lockss_turtles-0.6.0.dev23}/src/lockss/turtles/cli.py

@@ -144,22 +144,18 @@ class PluginJarOptions(BaseModel):
 
 
 class NonInteractiveOptions(BaseModel):
-    non_interactive: Optional[bool] = Field(False, description='(plugin signing credentials) disallow interactive prompts')
+    non_interactive: Optional[bool] = Field(False,
+                                            description='(plugin signing credentials) disallow interactive prompts')
 
 
-class BuildPluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginBuildingOptions, PluginIdentifierOptions):
-    pass
-
-
-class DeployPluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginDeploymentOptions, PluginJarOptions):
-    pass
+class TurtlesCommand(BaseModel):
 
+    class BuildPluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginBuildingOptions, PluginIdentifierOptions): pass
 
-class ReleasePluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginDeploymentOptions, PluginBuildingOptions, PluginIdentifierOptions):
-    pass
+    class DeployPluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginDeploymentOptions, PluginJarOptions): pass
 
+    class ReleasePluginCommand(OutputFormatOptions, NonInteractiveOptions, PluginDeploymentOptions, PluginBuildingOptions, PluginIdentifierOptions): pass
 
-class TurtlesCommand(BaseModel):
     bp: Optional[BuildPluginCommand] = Field(description='synonym for: build-plugin')
     build_plugin: Optional[BuildPluginCommand] = Field(description='build plugins', alias='build-plugin')
     copyright: Optional[StringCommand.type(__copyright__)] = Field(description=COPYRIGHT_DESCRIPTION)
@@ -237,10 +233,10 @@ class TurtlesCli(BaseCli[TurtlesCommand]):
     #     if len(result) > 0:
     #         self._tabulate(title, result, headers)
 
-    def _bp(self, build_plugin_command: BuildPluginCommand) -> None:
+    def _bp(self, build_plugin_command: TurtlesCommand.BuildPluginCommand) -> None:
         return self._build_plugin(build_plugin_command)
 
-    def _build_plugin(self, build_plugin_command: BuildPluginCommand) -> None:
+    def _build_plugin(self, build_plugin_command: TurtlesCommand.BuildPluginCommand) -> None:
         errs = []
         for psc in build_plugin_command.get_plugin_set_catalogs():
             try:
@@ -276,7 +272,7 @@ class TurtlesCli(BaseCli[TurtlesCommand]):
     def _copyright(self, string_command: StringCommand) -> None:
         self._do_string_command(string_command)
 
-    def _deploy_plugin(self, deploy_plugin_command: DeployPluginCommand) -> None:
+    def _deploy_plugin(self, deploy_plugin_command: TurtlesCommand.DeployPluginCommand) -> None:
         errs = []
         for prc in deploy_plugin_command.get_plugin_registry_catalogs():
             try:
@@ -307,7 +303,7 @@ class TurtlesCli(BaseCli[TurtlesCommand]):
     def _do_string_command(self, string_command: StringCommand) -> None:
         string_command()
 
-    def _dp(self, deploy_plugin_command: DeployPluginCommand) -> None:
+    def _dp(self, deploy_plugin_command: TurtlesCommand.DeployPluginCommand) -> None:
         return self._deploy_plugin(deploy_plugin_command)
 
     def _license(self, string_command: StringCommand) -> None:
@@ -322,7 +318,7 @@ class TurtlesCli(BaseCli[TurtlesCommand]):
             self._parser.error('no plugin signing password specified while in non-interactive mode')
         self._app.set_password(lambda: _p)
 
-    def _release_plugin(self, release_plugin_command: ReleasePluginCommand) -> None:
+    def _release_plugin(self, release_plugin_command: TurtlesCommand.ReleasePluginCommand) -> None:
         errs = []
         for psc in release_plugin_command.get_plugin_set_catalogs():
             try:
@@ -371,7 +367,7 @@ class TurtlesCli(BaseCli[TurtlesCommand]):
                                 headers=['Plugin identifier', 'Plugin version', 'Plugin registry', 'Plugin registry layer', 'Deployed JAR'],
                                 tablefmt=release_plugin_command.output_format))
 
-    def _rp(self, release_plugin_command: ReleasePluginCommand) -> None:
+    def _rp(self, release_plugin_command: TurtlesCommand.ReleasePluginCommand) -> None:
         self._release_plugin(release_plugin_command)
 
     def _version(self, string_command: StringCommand) -> None: