Print default values for strun --help

CHANGES.rst

@@ -2,6 +2,8 @@
 ==================
 
 - Print out ``jwst`` or ``romancal`` versions from ``strun --version``. [#98]
+- Print default parameter values for ``strun <step_alias> --help`` [#101]
+- Move ``strun`` to entrypoints [#101]
 
 0.5.0 (2023-04-19)
 ==================

pyproject.toml

@@ -42,6 +42,7 @@ test = [
 
 [project.scripts]
 stpipe = 'stpipe.cli.main:main'
+strun = 'stpipe.cli.strun:main'
 
 [build-system]
 requires = [

setup.py

@@ -1,11 +1,3 @@
-from pathlib import Path
-
 from setuptools import setup
 
-scripts = [
-    str(filename)
-    for filename in Path("./scripts").glob("**/*")
-    if filename.is_file() and filename.name != "__pycache__"
-]
-
-setup(scripts=scripts)
+setup()

scripts/strun → src/stpipe/cli/strun.py

@@ -1,29 +1,27 @@
-#!/usr/bin/env python
-
-"""
-Run Steps from the command line
-
-Exit Status
------------
-    0:  Step completed satisfactorily
-    1:  General error occurred
-
-Other status codes are Step implementation-specific.
-"""
-
 import sys
 
 from stpipe import Step
 from stpipe.cli.main import _print_versions
 from stpipe.exceptions import StpipeExitException
 
-if __name__ == "__main__":
+
+def main():
+    """
+    Run Steps from the command line
+
+    Exit Status
+    -----------
+        0:  Step completed satisfactorily
+        1:  General error occurred
+
+    Other status codes are Step implementation-specific.
+    """
     if "--version" in sys.argv:
         _print_versions()
         sys.exit(0)
 
     try:
-        step = Step.from_cmdline(sys.argv[1:])
+        Step.from_cmdline(sys.argv[1:])
     except StpipeExitException as e:
         sys.exit(e.exit_status)
     except Exception:

src/stpipe/cmdline.py

@@ -89,6 +89,12 @@ def build_from_spec(subspec, parts=[]):
             else:
                 comment = subspec.inline_comments.get(key) or ""
                 comment = comment.lstrip("#").strip()
+                # Only show default value if it is not None or the empty string
+                default_value_string = val.split("(")[1].rstrip(")").strip()
+                if default_value_string.lstrip("default=") in ["None", "''", '""']:
+                    help_string = comment
+                else:
+                    help_string = f"{comment} [{default_value_string}]"
                 argument = "--" + ".".join(parts + [key])
                 if argument[2:] in built_in_configuration_parameters:
                     raise ValueError(
@@ -98,7 +104,7 @@ def build_from_spec(subspec, parts=[]):
                 parser.add_argument(
                     "--" + ".".join(parts + [key]),
                     type=str,
-                    help=comment,
+                    help=help_string,
                     metavar="",
                 )
 

src/stpipe/tests/test_abstract_datamodel.py → tests/test_abstract_datamodel.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from ..step import AbstractDataModel
+from stpipe.datamodel import AbstractDataModel
 
 
 def test_roman_datamodel():