xamari: New supplementary tool for managing Amarisoft LTE services.

Only main driver framework here without actual subcommands.

Based on similar main driver from Zodbtools:

https://lab.nexedi.com/nexedi/zodbtools/blob/master/zodbtools/zodb.py

README.rst

@@ -2,4 +2,6 @@
  XLTE - Assorted LTE tools
 ===========================
 
-XLTE repository provides assorted tools and modules with functionality related to LTE.
+XLTE repository provides assorted tools and modules with functionality related to LTE:
+
+- `xamari` - supplementary tool for managing Amarisoft LTE services.

amari/__init__.py

+# -*- coding: utf-8 -*-
+# Copyright (C) 2022  Nexedi SA and Contributors.
+#                     Kirill Smelkov <kirr@nexedi.com>
+#
+# This program is free software: you can Use, Study, Modify and Redistribute
+# it under the terms of the GNU General Public License version 3, or (at your
+# option) any later version, as published by the Free Software Foundation.
+#
+# You can also Link and Combine this program with other software covered by
+# the terms of any of the Free Software licenses or any of the Open Source
+# Initiative approved licenses and Convey the resulting work. Corresponding
+# source of such a combination shall include the source code for all other
+# software used.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See COPYING file for full licensing terms.
+# See https://www.nexedi.com/licensing for rationale and options.
+"""Package xlte.amari is top-level home for functionality related to Amarisoft LTE stack.
+"""

amari/help.py

+# -*- coding: utf-8 -*-
+# xamari - help topics
+# Copyright (C) 2022  Nexedi SA and Contributors.
+#                     Kirill Smelkov <kirr@nexedi.com>
+#
+# This program is free software: you can Use, Study, Modify and Redistribute
+# it under the terms of the GNU General Public License version 3, or (at your
+# option) any later version, as published by the Free Software Foundation.
+#
+# You can also Link and Combine this program with other software covered by
+# the terms of any of the Free Software licenses or any of the Open Source
+# Initiative approved licenses and Convey the resulting work. Corresponding
+# source of such a combination shall include the source code for all other
+# software used.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See COPYING file for full licensing terms.
+# See https://www.nexedi.com/licensing for rationale and options.
+
+from collections import OrderedDict
+
+# topic_name -> (topic_summary, topic_help)
+topic_dict = OrderedDict()

amari/xamari.py

+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Based on https://lab.nexedi.com/nexedi/zodbtools/blob/master/zodbtools/zodb.py
+# Copyright (C) 2017-2022  Nexedi SA and Contributors.
+#                          Kirill Smelkov <kirr@nexedi.com>
+#                          Jérome Perrin <jerome@nexedi.com>
+#
+# This program is free software: you can Use, Study, Modify and Redistribute
+# it under the terms of the GNU General Public License version 3, or (at your
+# option) any later version, as published by the Free Software Foundation.
+#
+# You can also Link and Combine this program with other software covered by
+# the terms of any of the Free Software licenses or any of the Open Source
+# Initiative approved licenses and Convey the resulting work. Corresponding
+# source of such a combination shall include the source code for all other
+# software used.
+#
+# This program is distributed WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# See COPYING file for full licensing terms.
+# See https://www.nexedi.com/licensing for rationale and options.
+"""xamari is a driver program for invoking xlte.amari subcommands"""
+
+from __future__ import print_function
+
+from xlte.amari import help as help_module
+
+import getopt
+import importlib
+import sys
+
+
+# command_name -> command_module
+command_dict = {}
+
+def register_command(cmdname):
+    command_module = importlib.import_module('xlte.amari.' + cmdname)
+    command_dict[cmdname] = command_module
+
+for _ in ():
+    register_command(_)
+
+
+
+def usage(out):
+    print("""\
+xamari is supplemenrary tool for managing Amarisoft LTE services.
+
+Usage:
+
+    xamari command [arguments]
+
+The commands are:
+""", file=out)
+
+    for cmd, cmd_module in sorted(command_dict.items()):
+        print("    %-11s %s" % (cmd, cmd_module.summary), file=out)
+
+    print("""\
+
+Use "xamari help [command]" for more information about a command.
+
+Additional help topics:
+""", file=out)
+
+    # NOTE no sorting here - topic_dict is pre-ordered
+    for topic, (topic_summary, _) in help_module.topic_dict.items():
+        print("    %-11s %s" % (topic, topic_summary), file=out)
+
+    print("""\
+
+Use "xamari help [topic]" for more information about that topic.
+""", file=out)
+
+
+# help shows general help or help for a command/topic
+def help(argv):
+    if len(argv) < 2:   # help topic ...
+        usage(sys.stderr)
+        sys.exit(2)
+
+    topic = argv[1]
+
+    # topic can either be a command name or a help topic
+    if topic in command_dict:
+        command = command_dict[topic]
+        command.usage(sys.stdout)
+        sys.exit(0)
+
+    if topic in help_module.topic_dict:
+        _, topic_help = help_module.topic_dict[topic]
+        print(topic_help)
+        sys.exit(0)
+
+    print("Unknown help topic `%s`.  Run 'xamari help'." % topic, file=sys.stderr)
+    sys.exit(2)
+
+
+def main():
+    try:
+        optv, argv = getopt.getopt(sys.argv[1:], "h", ["help"])
+    except getopt.GetoptError as e:
+        print(e, file=sys.stderr)
+        usage(sys.stderr)
+        sys.exit(2)
+
+    for opt, _ in optv:
+        if opt in ("-h", "--help"):
+            usage(sys.stdout)
+            sys.exit(0)
+
+    if len(argv) < 1:
+        usage(sys.stderr)
+        sys.exit(2)
+
+    command = argv[0]
+
+    # help on a topic
+    if command=="help":
+        return help(argv)
+
+    # run subcommand
+    command_module = command_dict.get(command)
+    if command_module is None:
+        print('xamari: unknown subcommand "%s"' % command, file=sys.stderr)
+        print("Run 'xamari help' for usage.", file=sys.stderr)
+        sys.exit(2)
+
+    return command_module.main(argv)
+
+
+if __name__ == '__main__':
+    main()

setup.py

@@ -88,6 +88,11 @@ setup(
     cmdclass    = {'build_py':      build_py,
                   },
 
+    entry_points= {'console_scripts': [
+                        'xamari     = xlte.amari.xamari:main',
+                      ]
+                  },
+
     classifiers = [_.strip() for _ in """\
         Development Status :: 2 - Pre-Alpha
         Intended Audience :: Developers