lockss-turtles 0.4.0.dev1__py3-none-any.whl → 0.4.0.dev3__py3-none-any.whl

CHANGELOG.rst

@@ -14,6 +14,8 @@ Released: ?
 
    *  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.

lockss/turtles/__init__.py

@@ -28,7 +28,7 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-__version__ = '0.4.0-dev1'
+__version__ = '0.4.0-dev3'
 
 __copyright__ = '''
 Copyright (c) 2000-2023, Board of Trustees of Leland Stanford Jr. University

lockss/turtles/cli.py

@@ -31,9 +31,11 @@
 import argparse
 import getpass
 from pathlib import Path
-import tabulate
 import sys
 
+import rich_argparse
+import tabulate
+
 import lockss.turtles
 from lockss.turtles.app import TurtlesApp
 from lockss.turtles.plugin_registry import PluginRegistryLayer
@@ -162,7 +164,7 @@ class TurtlesCli(object):
         if self._identifiers is None:
             self._identifiers = list()
             self._identifiers.extend(self._args.remainder)
-            self._identifiers.extend(self._args.get_identifier)
+            self._identifiers.extend(self._args.identifier)
             for path in self._args.identifiers:
                 self._identifiers.extend(_file_lines(path))
             if len(self._identifiers) == 0:
@@ -297,9 +299,17 @@ class TurtlesCli(object):
                            help='add the layers in %(metavar)s to the list of plugin registry layers to process')
 
     def _make_parser(self):
-        self._parser = argparse.ArgumentParser(prog=TurtlesCli.PROG)
+        for cls in [rich_argparse.RichHelpFormatter]:
+            cls.styles.update({
+                'argparse.args': f'bold {cls.styles["argparse.args"]}',
+                'argparse.groups': f'bold {cls.styles["argparse.groups"]}',
+                'argparse.metavar': f'bold {cls.styles["argparse.metavar"]}',
+                'argparse.prog': f'bold {cls.styles["argparse.prog"]}',
+            })
+        self._parser = argparse.ArgumentParser(prog=TurtlesCli.PROG,
+                                               formatter_class=rich_argparse.RichHelpFormatter)
         self._subparsers = self._parser.add_subparsers(title='commands',
-                                                       description="Add --help to see the command's own help message",
+                                                       description="Add --help to see the command's own help message.",
                                                        # With subparsers, metavar is also used as the heading of the column of subcommands
                                                        metavar='COMMAND',
                                                        # With subparsers, help is used as the heading of the column of subcommand descriptions
@@ -326,8 +336,9 @@ class TurtlesCli(object):
 
     def _make_parser_build_plugin(self, container):
         parser = container.add_parser('build-plugin', aliases=['bp'],
-                                      description='Build (package and sign) plugins',
-                                      help='build (package and sign) plugins')
+                                      description='Build (package and sign) plugins.',
+                                      help='build (package and sign) plugins',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._build_plugin)
         self._make_option_output_format(parser)
         self._make_option_password(parser)
@@ -337,14 +348,16 @@ class TurtlesCli(object):
 
     def _make_parser_copyright(self, container):
         parser = container.add_parser('copyright',
-                                      description='Show copyright and exit',
-                                      help='show copyright and exit')
+                                      description='Show copyright and exit.',
+                                      help='show copyright and exit',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._copyright)
 
     def _make_parser_deploy_plugin(self, container):
         parser = container.add_parser('deploy-plugin', aliases=['dp'],
-                                      description='Deploy plugins',
-                                      help='deploy plugins')
+                                      description='Deploy plugins.',
+                                      help='deploy plugins',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._deploy_plugin)
         self._make_option_output_format(parser)
         self._make_option_plugin_registry_catalog(parser)
@@ -355,14 +368,16 @@ class TurtlesCli(object):
 
     def _make_parser_license(self, container):
         parser = container.add_parser('license',
-                                      description='Show license and exit',
-                                      help='show license and exit')
+                                      description='Show license and exit.',
+                                      help='show license and exit',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._license)
 
     def _make_parser_release_plugin(self, container):
         parser = container.add_parser('release-plugin', aliases=['rp'],
-                                      description='Release (build and deploy) plugins',
-                                      help='release (build and deploy) plugins')
+                                      description='Release (build and deploy) plugins.',
+                                      help='release (build and deploy) plugins',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._release_plugin)
         self._make_option_output_format(parser)
         self._make_option_password(parser)
@@ -376,14 +391,16 @@ class TurtlesCli(object):
 
     def _make_parser_usage(self, container):
         parser = container.add_parser('usage',
-                                      description='Show detailed usage and exit',
-                                      help='show detailed usage and exit')
+                                      description='Show detailed usage and exit.',
+                                      help='show detailed usage and exit',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._usage)
 
     def _make_parser_version(self, container):
         parser = container.add_parser('version',
-                                      description='Show version and exit',
-                                      help='show version and exit')
+                                      description='Show version and exit.',
+                                      help='show version and exit',
+                                      formatter_class=self._parser.formatter_class)
         parser.set_defaults(fun=self._version)
 
     def _obtain_password(self):

{lockss_turtles-0.4.0.dev1.dist-info → lockss_turtles-0.4.0.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lockss-turtles
-Version: 0.4.0.dev1
+Version: 0.4.0.dev3
 Summary: Tool to manage LOCKSS plugin sets and LOCKSS plugin registries
 Home-page: https://www.lockss.org/
 License: BSD-3-Clause
@@ -23,6 +23,7 @@ Classifier: Topic :: Utilities
 Requires-Dist: java-manifest (>=1.1.0,<2.0.0)
 Requires-Dist: jsonschema (>=4.17.3,<5.0.0)
 Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: rich-argparse (>=1.1.0,<2.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: xdg (>=6.0.0,<7.0.0)
 Project-URL: Repository, https://github.com/lockss/lockss-turtles
@@ -32,6 +33,9 @@ Description-Content-Type: text/x-rst
 Turtles
 =======
 
+.. |RELEASE| replace:: 0.4.0-dev3
+.. |RELEASE_DATE| replace:: ?
+
 .. |HELP| replace:: ``--help/-h``
 .. |IDENTIFIER| replace:: ``--identifier/-i``
 .. |IDENTIFIERS| replace:: ``--identifiers/-I``
@@ -47,7 +51,7 @@ Turtles
 
 Turtles is a tool to manage LOCKSS plugin sets and LOCKSS plugin registries.
 
-**Latest release:** 0.4.0-dev1 (?)
+**Latest release:** |RELEASE| (|RELEASE_DATE|)
 
 -----------------
 Table of Contents
@@ -292,7 +296,16 @@ Maven Plugin Set Builder Prerequisites
 Maven Plugin Set Builder Declaration
 ++++++++++++++++++++++++++++++++++++
 
-For this plugin set builder type, the ``builder`` object in the plugin set definition has the following structure:
+For this plugin set builder type, the ``builder`` object in the plugin set definition has the following structure::
+
+    ---
+    kind: PluginSet
+    id: ...
+    name: ...
+    builder:
+      type: mvn
+      main: ...
+      test: ...
 
 ``type``
    *Required.* Must be set to ``mvn``.
@@ -320,7 +333,16 @@ Ant Plugin Set Builder Prerequisites
 Ant Plugin Set Builder Declaration
 ++++++++++++++++++++++++++++++++++
 
-For this plugin set builder type, the ``builder`` object in the plugin set definition has the following structure:
+For this plugin set builder type, the ``builder`` object in the plugin set definition has the following structure::
+
+    ---
+    kind: PluginSet
+    id: ...
+    name: ...
+    builder:
+      type: ant
+      main: ...
+      test: ...
 
 ``type``
    *Required.* Must be set to ``ant``.
@@ -370,12 +392,6 @@ A plugin registry is defined by a YAML document::
       type: ...
       ...
     layers:
-      - id: testing
-        name: My Plugin Registry (Testing)
-        path: /path/to/testing
-      - id: production
-        name: My Plugin Registry (Production)
-        path: /path/to/production
       - ...
     plugin-identifiers:
       - edu.myuniversity.plugin.publisherx.PublisherXPlugin
@@ -411,7 +427,7 @@ The contents are described below:
 ``plugin-identifiers``
    *Required.* Non-empty list of the plugin identifiers in this plugin registry.
 
-``plugin-identifiers``
+``suppressed-plugin-identifiers``
    *Optional.* Non-empty list of plugin identifiers that are excluded from this plugin registry.
 
    Turtles does not currently do anything with this information, but it can be used to record plugins that have been abandoned or retracted over the lifetime of the plugin registry.
@@ -438,12 +454,33 @@ None.
 Directory Plugin Registry Layout Declaration
 ++++++++++++++++++++++++++++++++++++++++++++
 
-For this plugin registry layout type, the ``layout`` object in the plugin registry definition has the following structure:
+For this plugin registry layout type, the ``layout`` object in the plugin registry definition has the following structure::
+
+    ---
+    kind: PluginRegistry
+    id: ...
+    name: ...
+    layout:
+      type: directory
+      file-naming-convention: ...
+    layers:
+      - ...
+    plugin-identifiers:
+      - ...
+    suppressed-plugin-identifiers:
+      - ...
 
 ``type``
    *Required.* Must be set to ``directory``.
 
-Currently, this layout type does not support the ``file-naming-convention`` option of the `RCS Plugin Registry Layout`_, but this feature will be introduced in a future release.
+``file-naming-convention``
+   *Optional.* A rule for what to name each deployed JAR file. If unspecified, the behavior is that of ``identifier``. Can be one of:
+
+   *  ``identifier``: Use the plugin identifier and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar``.
+
+   *  ``underscore``: Replace ``.`` in the plugin identifier with ``_``, and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``edu_myuniversity_plugin_publisherx_PublisherXPlugin.jar``.
+
+   *  ``abbreviated``: Use the last dotted component of the plugin identifier and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``PublisherXPlugin.jar``.
 
 RCS Plugin Registry Layout
 --------------------------
@@ -458,7 +495,21 @@ RCS Plugin Registry Layout Prerequisites
 RCS Plugin Registry Layout Declaration
 ++++++++++++++++++++++++++++++++++++++
 
-For this plugin registry layout type, the ``layout`` object in the plugin registry definition has the following structure:
+For this plugin registry layout type, the ``layout`` object in the plugin registry definition has the following structure::
+
+    ---
+    kind: PluginRegistry
+    id: ...
+    name: ...
+    layout:
+      type: rcs
+      file-naming-convention: ...
+    layers:
+      - ...
+    plugin-identifiers:
+      - ...
+    suppressed-plugin-identifiers:
+      - ...
 
 ``type``
    *Required.* Must be set to ``rcs``.
@@ -468,7 +519,9 @@ For this plugin registry layout type, the ``layout`` object in the plugin regist
 
    *  ``identifier``: Use the plugin identifier and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar``.
 
-   *  ``abbreviated``: Use the last component of the plugin identifier and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``PublisherXPlugin.jar``.
+   *  ``underscore``: Replace ``.`` in the plugin identifier with ``_``, and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``edu_myuniversity_plugin_publisherx_PublisherXPlugin.jar``.
+
+   *  ``abbreviated``: Use the last dotted component of the plugin identifier and add ``.jar``. For example ``edu.myuniversity.plugin.publisherx.PublisherXPlugin`` results in ``PublisherXPlugin.jar``.
 
 Plugin Registry Layers
 ======================
@@ -483,7 +536,27 @@ Although the identifiers (see ``id`` below) and display names (see ``name`` belo
 
 It is possible for multiple plugin registries to have a layer ``path`` in common. An example would be a team working on several plugin registries for different purposes, having distinct (public) production layer paths, but sharing a single (internal) testing layer path, if they are the only audience for it.
 
-A plugin registry layer is defined as one of the objects in the plugin registry definition's ``layers`` list. Each layer object has the following structure:
+A plugin registry layer is defined as one of the objects in the plugin registry definition's ``layers`` list. Each layer object has the following structure::
+
+    ---
+    kind: PluginRegistry
+    id: ...
+    name: ...
+    layout:
+      type: ...
+      ...
+    layers:
+      - id: testing
+        name: My Plugin Registry (Testing)
+        path: /path/to/testing
+      - id: production
+        name: My Plugin Registry (Production)
+        path: /path/to/production
+      - ...
+    plugin-identifiers:
+      - ...
+    suppressed-plugin-identifiers:
+      - ...
 
 ``id``
    *Required.* A short identifier for the plugin registry layer, for example ``testing``.
@@ -598,7 +671,7 @@ The top-level executable alone does not perform any action or default to a given
                             disallow interactive prompts (default: allow)
 
     commands:
-      Add --help to see the command's own help message
+      Add --help to see the command's own help message.
 
       COMMAND               DESCRIPTION
         build-plugin (bp)   build (package and sign) plugins
@@ -623,7 +696,7 @@ The ``build-plugin`` command is used for `Building Plugins`_. It has its own |HE
                                 [--identifier PLUGID] [--identifiers FILE]
                                 [PLUGID ...]
 
-    Build (package and sign) plugins
+    Build (package and sign) plugins.
 
     options:
       -h, --help            show this help message and exit
@@ -668,6 +741,8 @@ The command needs:
 
 *  One or more plugin identifiers, from the `Plugin Identifier Arguments and Options`_ (bare arguments, |IDENTIFIER| options, |IDENTIFIERS| options).
 
+It also accepts `Options`_ for `Output Format Control`_
+
 Examples::
 
     # Help message
@@ -711,7 +786,7 @@ The ``deploy-plugin`` command is used for `Deploying Plugins`_. It has its own |
                                  [--layer LAYER] [--layers FILE]
                                  [PLUGJAR ...]
 
-    Deploy plugins
+    Deploy plugins.
 
     options:
       -h, --help            show this help message and exit
@@ -765,6 +840,8 @@ The command needs:
 
    *  The JAR paths found in the files listed as |JARS| options.
 
+It also accepts `Options`_ for `Output Format Control`_.
+
 Examples::
 
     # Help message
@@ -814,7 +891,7 @@ The ``release-plugin`` command is used for `Building Plugins`_ and `Deploying Pl
                                   [--layers FILE]
                                   [PLUGID ...]
 
-    Release (build and deploy) plugins
+    Release (build and deploy) plugins.
 
     options:
       -h, --help            show this help message and exit
@@ -882,6 +959,8 @@ The command needs:
 
 *  One or more plugin identifiers, from the `Plugin Identifier Arguments and Options`_ (bare arguments, |IDENTIFIER| options, |IDENTIFIERS| options).
 
+It also accepts `Options`_ for `Output Format Control`_.
+
 Examples::
 
     # Help message

{lockss_turtles-0.4.0.dev1.dist-info → lockss_turtles-0.4.0.dev3.dist-info}/RECORD

@@ -1,8 +1,8 @@
-CHANGELOG.rst,sha256=q-WdgxGyEUiHVUiqg6JgxKlHxfCGfY9dCVMYatb0HZ8,3133
-lockss/turtles/__init__.py,sha256=mASwMXUfE67Vvo3sr8WnczkWPC6qjIpmfa6Gm51yc5Y,3201
+CHANGELOG.rst,sha256=Lv-bS9-c4dtclJrtlNr8HymmhR283_WgqERmG-Qqg8A,3158
+lockss/turtles/__init__.py,sha256=51WIQO-8H8jLDlJIE4s8kIbzN_Ucz3yvwC3L_EHkMfo,3201
 lockss/turtles/__main__.py,sha256=57NMiI-NAibLExMX0Y6QApQhaDUblHTQqCDSiWBVt6k,1633
 lockss/turtles/app.py,sha256=X6AoOPPJEKrhcT9kwNXp7J7XO3KLoXdLdozgKf49Ajw,9074
-lockss/turtles/cli.py,sha256=YN0tCk_kCCpSjgIB-y5wpvtP4tg3S2wLFvxntmqJapI,21367
+lockss/turtles/cli.py,sha256=yZqmRrGSY_4aMAv6nvx-ax6Lab_ckoNg1BVsOuoGm1U,22476
 lockss/turtles/plugin.py,sha256=ewDT3d_QPKnQqO_zuiD2XQaDcJSzoVDPylmFPe_OELU,4312
 lockss/turtles/plugin_registry.py,sha256=8MXzfybo-0jmBgIQlcTMbLvJVgU3ZsYomdP0PnMh2RM,9445
 lockss/turtles/plugin_set.py,sha256=jB8fGMwsYdXcZab_GRcvTahVCnjW94AkyWeHlgg7qLc,10486
@@ -13,8 +13,8 @@ lockss/turtles/resources/plugin-set-catalog-schema.json,sha256=UbB0BCd9jdROGyXf2
 lockss/turtles/resources/plugin-set-schema.json,sha256=EeptOiipJdWwfLIxUHXap59Hbq32UXzT2MpI2eADM1U,2338
 lockss/turtles/resources/plugin-signing-credentials-schema.json,sha256=VLld14jOMG8V_ru0jtQD5GunNDNLp2MoRGMSZg9xVn8,753
 lockss/turtles/util.py,sha256=g3pGADgnmaQce3pNrpA1VjuSlNUJUAITyPyM6pNdVOA,2430
-lockss_turtles-0.4.0.dev1.dist-info/LICENSE,sha256=ArAnVWK-WhSxCVQWDF_PWBETwjSZ35HfugnUJPqPXyg,1506
-lockss_turtles-0.4.0.dev1.dist-info/METADATA,sha256=L_Yz1e1aYFBFNY-vRX3OJf91uQ_V6vzjKFhevkPO4xs,37326
-lockss_turtles-0.4.0.dev1.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
-lockss_turtles-0.4.0.dev1.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
-lockss_turtles-0.4.0.dev1.dist-info/RECORD,,
+lockss_turtles-0.4.0.dev3.dist-info/LICENSE,sha256=ArAnVWK-WhSxCVQWDF_PWBETwjSZ35HfugnUJPqPXyg,1506
+lockss_turtles-0.4.0.dev3.dist-info/METADATA,sha256=_6t341PXJGg_osEaHNh7Q5GVGE3X9Vx6R-ZJmJJvREU,39406
+lockss_turtles-0.4.0.dev3.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+lockss_turtles-0.4.0.dev3.dist-info/entry_points.txt,sha256=25BAVFSBRKWAWiXIGZgcr1ypt2mV7nj31Jl8WcNZZOk,51
+lockss_turtles-0.4.0.dev3.dist-info/RECORD,,

{lockss_turtles-0.4.0.dev1.dist-info → lockss_turtles-0.4.0.dev3.dist-info}/WHEEL

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