Merge pull request #268 from ReadAlongs/dev.ej/cli-tweaks

Dev.ej/cli tweaks

Author: joanise

readalongs/cli.py

@@ -34,7 +34,7 @@
 }
 
 SUPPORTED_OUTPUT_FORMATS_DESC = ", ".join(
-    k + f" ({v})" for k, v in SUPPORTED_OUTPUT_FORMATS.items()
+    k + f" ({v})" for k, v in SUPPORTED_OUTPUT_FORMATS.items() if k != "html"
 )
 
 
@@ -122,6 +122,14 @@ def cli():
     """
 
 
+LANGUAGES_DETAILS = (
+    "use 'und' for the generic language-independent mapping; "
+    "multiple codes can be joined by ',' or ':', or by repeating the option, "
+    "to enable the g2p cascade (run 'readalongs g2p -h' for details); "
+    "run 'readalongs langs' to list all supported languages."
+)
+
+
 @cli.command(  # type: ignore  # noqa: C901  # some versions of flake8 need this here
     context_settings=CONTEXT_SETTINGS, short_help="Force align a text and a sound file."
 )
@@ -147,8 +155,8 @@ def cli():
     callback=JoinerCallbackForClick(SUPPORTED_OUTPUT_FORMATS, drop_case=True),
     help=(
         "Comma- or colon-separated list of additional output file formats to export to. "
-        "The text is always exported as XML and alignments as SMIL, but "
-        "one or more of these formats can be requested in addition:\b \n\n"
+        "The www bundle and Offline HTML are always generated, "
+        "but one or more of these formats can be requested in addition:\b \n\n"
         + SUPPORTED_OUTPUT_FORMATS_DESC
     ),
 )
@@ -189,9 +197,7 @@ def cli():
     callback=JoinerCallbackForClick(get_langs_deferred()),
     help=(
         "The language code(s) for text in TEXTFILE (use only with plain text input); "
-        "multiple codes can be joined by ',' or ':', or by repeating the option, "
-        "to enable the g2p cascade (run 'readalongs g2p -h' for details); "
-        "run 'readalongs langs' to list all supported languages."
+        + LANGUAGES_DETAILS
     ),
 )
 @click.option(
@@ -365,7 +371,8 @@ def align(**kwargs):  # noqa: C901  # some versions of flake8 need this here ins
         if not kwargs["language"]:
             raise click.BadParameter(
                 "No input language specified for plain text input. "
-                "Please provide the -l/--language switch."
+                "Please provide the -l/--language switch.\n"
+                "You can use '-l und' if you don't know the language or if it's not explicitly supported."
             )
         languages = list(kwargs["language"])
         if not kwargs["lang_no_append_und"] and "und" not in languages:
@@ -402,6 +409,9 @@ def align(**kwargs):  # noqa: C901  # some versions of flake8 need this here ins
         # sys.exit(1)
 
     output_formats = kwargs["output_formats"]
+    # Now that Offline HTML is the editable format in Studio-Web, always generate it.
+    if "html" not in output_formats:
+        output_formats = [*output_formats, "html"]
 
     save_readalong(
         align_results=results,
@@ -418,6 +428,7 @@ def align(**kwargs):  # noqa: C901  # some versions of flake8 need this here ins
     context_settings=CONTEXT_SETTINGS,
     short_help="Renamed: use 'readalongs make-xml' instead.",
     deprecated=True,
+    hidden=True,
 )
 @click.argument("plaintextfile", type=click.File("r", encoding="utf-8-sig", lazy=True))
 @click.argument("xmlfile", type=click.Path(), required=False, default="")
@@ -439,12 +450,7 @@ def align(**kwargs):  # noqa: C901  # some versions of flake8 need this here ins
     required=True,
     multiple=True,
     callback=JoinerCallbackForClick(get_langs_deferred()),
-    help=(
-        "The language code(s) for text in PLAINTEXTFILE; "
-        "multiple codes can be joined by ',' or ':', or by repeating the option, "
-        "to enable the g2p cascade (run 'readalongs g2p -h' for details); "
-        "run 'readalongs langs' to list all supported languages."
-    ),
+    help=("The language code(s) for text in PLAINTEXTFILE; " + LANGUAGES_DETAILS),
 )
 def prepare(**kwargs):
     """DEPRECATED - renamed: use `readalongs make-xml` instead.
@@ -491,12 +497,7 @@ def prepare(**kwargs):
     required=True,
     multiple=True,
     callback=JoinerCallbackForClick(get_langs_deferred()),
-    help=(
-        "The language code(s) for text in PLAINTEXTFILE; "
-        "multiple codes can be joined by ',' or ':', or by repeating the option, "
-        "to enable the g2p cascade (run 'readalongs g2p -h' for details); "
-        "run 'readalongs langs' to list all supported languages."
-    ),
+    help=("The language code(s) for text in PLAINTEXTFILE; " + LANGUAGES_DETAILS),
 )
 def make_xml(**kwargs):
     """make XMLFILE for 'readalongs align' from PLAINTEXTFILE.