flowsh-cli 0.7.2__tar.gz → 0.8.0__tar.gz

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowsh-cli
-Version: 0.7.2
+Version: 0.8.0
 Summary: Generate Bash harness scripts from workflow YAML files.
 License-Expression: MIT
 Classifier: Programming Language :: Python :: 3.11
@@ -26,7 +26,7 @@ Use it when you want a small, reproducible way to encode a workflow once and rer
 uvx flowsh-cli path/to/workflows.yml
 ```
 
-That reads the workflow YAML at the path you provide and writes harnesses under `.harness/`.
+That reads the workflow YAML at the path you provide and writes harness scripts to the current working directory.
 
 In this repository, the example workflow file lives at `.made/workflows.yml`.
 
@@ -82,7 +82,7 @@ workflows:
             run: echo "$ITEM"
 ```
 
-Harness paths are derived from workflow ids. `wf_example` becomes `.harness/example.sh`.
+Harness paths are derived from workflow ids. `wf_example` becomes `example.sh` in the current working directory.
 
 ## Step Types
 

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/README.md

@@ -10,7 +10,7 @@ Use it when you want a small, reproducible way to encode a workflow once and rer
 uvx flowsh-cli path/to/workflows.yml
 ```
 
-That reads the workflow YAML at the path you provide and writes harnesses under `.harness/`.
+That reads the workflow YAML at the path you provide and writes harness scripts to the current working directory.
 
 In this repository, the example workflow file lives at `.made/workflows.yml`.
 
@@ -66,7 +66,7 @@ workflows:
             run: echo "$ITEM"
 ```
 
-Harness paths are derived from workflow ids. `wf_example` becomes `.harness/example.sh`.
+Harness paths are derived from workflow ids. `wf_example` becomes `example.sh` in the current working directory.
 
 ## Step Types
 

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "flowsh-cli"
-version = "0.7.2"
+version = "0.8.0"
 description = "Generate Bash harness scripts from workflow YAML files."
 readme = "README.md"
 requires-python = ">=3.11"

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/src/flowsh_cli/__init__.py

@@ -3,7 +3,7 @@
 from flowsh_cli.models import Workflow, WorkflowParseError, parse_workflows
 from flowsh_cli.render import harness_path, render_harness
 
-__version__ = "0.7.2"
+__version__ = "0.8.0"
 
 __all__ = [
     "Workflow",

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/src/flowsh_cli/cli.py

@@ -91,6 +91,14 @@ def generate(
             is_eager=True,
         ),
     ] = None,
+    output: Annotated[
+        Path | None,
+        typer.Option(
+            "--output",
+            metavar="PATH",
+            help="Write generated script to PATH. Only valid when generating a single workflow.",
+        ),
+    ] = None,
 ) -> None:
     """Generate Bash harnesses from workflow YAML."""
 
@@ -102,7 +110,14 @@ def generate(
     try:
         workflows = parse_workflows(workflow_yaml)
         selected = select_workflows(workflows, workflow)
-        write_harnesses(selected, dry_run=dry_run, force=force)
+        if output is not None and len(selected) != 1:
+            print(
+                "ERROR: --output requires exactly one workflow "
+                "(use --workflow or ensure the file contains only one workflow)",
+                file=sys.stderr,
+            )
+            raise typer.Exit(1)
+        write_harnesses(selected, dry_run=dry_run, force=force, output_path=output)
     except WorkflowParseError as error:
         print(f"ERROR: {error}", file=sys.stderr)
         raise typer.Exit(1) from error
@@ -159,8 +174,13 @@ def print_example(value: str | None) -> None:
     raise typer.Exit
 
 
-def write_harnesses(workflows: list[Workflow], *, dry_run: bool, force: bool) -> None:
-    output_paths = [(workflow, harness_path(workflow)) for workflow in workflows]
+def write_harnesses(
+    workflows: list[Workflow], *, dry_run: bool, force: bool, output_path: Path | None = None
+) -> None:
+    output_paths = [
+        (workflow, output_path if output_path is not None else harness_path(workflow))
+        for workflow in workflows
+    ]
 
     if dry_run:
         for workflow, output_path in output_paths:

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/src/flowsh_cli/examples.py

@@ -6,9 +6,12 @@ EXAMPLES: dict[str, tuple[str, str, str]] = {
         "Vars + sequential bash steps",
         "vars, bash",
         """\
+description: Simple workflow examples for demonstration purposes
+
 workflows:
   - id: wf_simple
     name: Simple example — vars and bash
+    description: Captures today's date and prints a greeting via sequential bash steps.
 
     steps:
       - type: vars

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/src/flowsh_cli/models.py

@@ -199,7 +199,11 @@ class WorkflowParam(StrictModel):
 class Workflow(StrictModel):
     id: str
     name: str
+    description: str | None = None
     params: list[WorkflowParam] = []
+    enabled: bool = True
+    schedule: str | None = None
+    shellScriptPath: str | None = None
     steps: list[Step]
 
     @field_validator("id")
@@ -227,6 +231,7 @@ class Workflow(StrictModel):
 
 
 class WorkflowFile(StrictModel):
+    description: str | None = None
     workflows: list[Workflow]
 
     @field_validator("workflows")

{flowsh_cli-0.7.2 → flowsh_cli-0.8.0}/src/flowsh_cli/render.py

@@ -16,7 +16,7 @@ from flowsh_cli.models import (
 
 
 def harness_path(workflow: Workflow) -> Path:
-    return Path(".harness") / f"{workflow.id.removeprefix('wf_')}.sh"
+    return Path(f"{workflow.id.removeprefix('wf_')}.sh")
 
 
 def render_harness(workflow: Workflow) -> str:
@@ -326,8 +326,9 @@ def _render_step_body(step: Step) -> list[str]:
             ]
         )
         if step.expandPrompt:
-            braced = re.findall(r"\$\{([A-Z_][A-Z0-9_]*)\}", step.prompt)
-            bare = re.findall(r"\$([A-Z_][A-Z0-9_]*)(?!\w)", step.prompt)
+            _prompt_no_code = re.sub(r"```.*?```", "", step.prompt, flags=re.DOTALL)
+            braced = re.findall(r"\$\{([A-Z_][A-Z0-9_]*)\}", _prompt_no_code)
+            bare = re.findall(r"\$([A-Z_][A-Z0-9_]*)(?!\w)", _prompt_no_code)
             seen: dict[str, None] = {}
             for var in braced + bare:
                 seen[var] = None