Fixed palette generation; adjusted action script to new command line;

updated docs

.github/workflows/create-palettes.yml

@@ -34,8 +34,8 @@ jobs:
 
       - name: Create palettes
         run: |
-          python3 tools/xml2palette/xml2palette.py -i ./ -t daliuge -o $OUTPUT_FILENAME.palette -p
-          python3 tools/xml2palette/xml2palette.py -i ./ -t template -o $OUTPUT_FILENAME-template.palette -p
+          python3 tools/xml2palette/xml2palette.py -t daliuge -r ./ $OUTPUT_FILENAME.palette
+          python3 tools/xml2palette/xml2palette.py -t template -r ./ $OUTPUT_FILENAME-template.palette
 
       - name: Commit palettes to EAGLE
         env:

docs/development/app_development/eagle_app_integration.rst

@@ -24,19 +24,30 @@ The xml2palette.py script is located in the tools directory within the DALiuGE r
 
 The xml2palette.py script can be run using this command line:
 
-.. code-block:: none
+.. code-block::
 
-  python3 xml2palette.py -i <path_to_input_directory> -t <tag> -o <path_output_file>
+  python3 xml2palette.py [-h] [-m MODULE] [-t TAG] [-c] [-r] [-s] [-v] idir ofile
 
+  positional arguments:
+    idir                  input directory path or file name
+    ofile                 output file name
 
-If no tag is specified, all components found in the input directory will part of the output file. If, however, a tag is specified, then only those components with a matching tag will be part of the output. Tags can be added to the Doxygen comments for a component using:
+  optional arguments:
+    -h, --help            show this help message and exit
+    -m MODULE, --module MODULE
+                          Module load path name
+    -t TAG, --tag TAG     filter components with matching tag
+    -c                    C mode, if not set Python will be used
+    -r, --recursive       Traverse sub-directories
+    -s, --parse_all       Try to parse non DAliuGE compliant functions and methods
+    -v, --verbose         increase output verbosity
+
+  If no tag is specified, all components found in the input directory will part of the output file. If, however, a tag is specified, then only those components with a matching tag will be part of the output. Tags can be added to the Doxygen comments for a component using:
 
 .. code-block:: python
 
   # @param tag <tag_name>
 
-There are also two optional arguments for xml2palette. Allow missing "EAGLE start" (-s) which allows xml2palette.py to run on code without any eagle-specific doxygen comments. Finally (-m) restricts xml2palette.py to produce a palette that only contains methods from within the specified module.
-
 Component Doxygen Markup Guide
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 In order to support the direct usage of newly written application components in the EAGLE editor, the |daliuge| system supports a custom set of Doxygen directives and tools. When writing an application component, developers can add specific custom `Doxygen <https://www.doxygen.nl/>`_ comments to the source code. These comments describe the component and can be used to automatically generate a JSON DALiuGE component description which in turn can be used in the *EAGLE*. A few basic rules to remember:

tools/xml2palette/xml2palette.py

@@ -1,4 +1,12 @@
 #!/usr/bin/env python
+"""
+Script processes a file or a directory of source files and
+produces a DALiuGE compatible palette file containing the
+information required to use functions and components in graphs.
+For more information please refer to the documentation
+https://daliuge.readthedocs.io/en/latest/development/app_development/eagle_app_integration.html#automatic-eagle-palette-generation
+
+"""
 
 import argparse
 import csv
@@ -92,33 +100,34 @@ class Language(Enum):
 
 def get_args():
     # inputdir, tag, outputfile, allow_missing_eagle_start, module_path, language
-    parser = argparse.ArgumentParser()
-    parser.add_argument("-v", "--verbose", help="increase output verbosity",
-                        action="store_true")
-    parser.add_argument("-i", "--idir", help="input directory path spec")
-    parser.add_argument("-o","--ofile", help="output file name")
-    parser.add_argument("-t", "--tag", help="tag to search for", default="")
-    parser.add_argument("-p", "--python", help="Python mode",
-                        action="store_true")
-    parser.add_argument("-c", help="C mode",
+    parser = argparse.ArgumentParser(epilog=__doc__,
+                            formatter_class=argparse.RawDescriptionHelpFormatter)
+    parser.add_argument("idir", help="input directory path or file name")
+    parser.add_argument("ofile", help="output file name")
+    parser.add_argument("-m", "--module", help="Module load path name",
+                        default="")
+    parser.add_argument("-t", "--tag", help="filter components with matching tag", default="")
+    parser.add_argument("-c", help="C mode, if not set Python will be used",
                         action="store_true")
     parser.add_argument("-r", "--recursive", help="Traverse sub-directories",
                         action="store_true")
-    parser.add_argument("-m", "--module_path", help="Module load path name",
-                        default="")
     parser.add_argument("-s", "--parse_all", 
-        help="Try to parse non DAliuGE compliant modules",
+        help="Try to parse non DAliuGE compliant functions and methods",
         action="store_true")
+    parser.add_argument("-v", "--verbose", help="increase output verbosity",
+                        action="store_true")
     args = parser.parse_args()
     if args.verbose:
         logging.getLogger().setLevel(logging.DEBUG)
     logging.debug("DEBUG logging switched on")
     if args.recursive:
         DOXYGEN_SETTINGS.append(("RECURSIVE", "YES"))
+        logging.info("Recursive flag ON")
     else:
         DOXYGEN_SETTINGS.append(("RECURSIVE", "NO"))
+        logging.info("Recursive flag OFF")
     language = Language.C if args.c else Language.PYTHON
-    return args.idir, args.tag, args.ofile, args.parse_all, args.module_path, language
+    return args.idir, args.tag, args.ofile, args.parse_all, args.module, language
 
 def check_environment_variables():
     required_environment_variables = ["PROJECT_NAME", "PROJECT_VERSION", "GIT_REPO"]