orchestra-cli 0.3.3__tar.gz → 0.3.5__tar.gz

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestra-cli
-Version: 0.3.3
+Version: 0.3.5
 Summary: Orchestra CLI. Perform operations with Orchestra locally.
 Author-email: Orchestra Technologies <support@getorchestra.io>
 Requires-Python: >=3.10
@@ -55,6 +55,8 @@ Commands follow a `noun verb` shape. The current nouns are `pipeline` and `task`
 | `orchestra pipeline build`           | Validate local YAML, create or update a draft pipeline, and start that draft version.       |
 | `orchestra task logs`                | Fetch or follow logs for a single task run.                                                 |
 
+Commands that read a local pipeline file (`pipeline validate`, `import`, `new`, `update`, `build`, and `run --path` with `--task`) accept `.yaml`, `.yml` and `.oml` files; any other extension is rejected. `.oml` files are read as YAML, so only OML written in YAML or JSON syntax is supported. OML block terminators (`.`) and embeds (`%sql ... %%`) fail with an `Invalid YAML` error.
+
 Use `orchestra --help`, `orchestra <noun> --help`, or `orchestra <noun> <verb> --help` for built-in help.
 
 ### Legacy command names
@@ -77,7 +79,7 @@ New code and documentation should prefer the noun/verb form.
 
 ## pipeline validate
 
-Validate a YAML file against the Orchestra API schema.
+Validate a pipeline file against the Orchestra API schema.
 
 ```bash
 orchestra pipeline validate path/to/pipeline.yaml
@@ -87,7 +89,7 @@ orchestra-cli pipeline validate path/to/pipeline.yaml
 
 Options
 
-- `file` (positional): Path to the YAML file to validate.
+- `file` (positional): Path to the `.yaml`, `.yml` or `.oml` file to validate.
 
 Behavior
 

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/README.md

@@ -41,6 +41,8 @@ Commands follow a `noun verb` shape. The current nouns are `pipeline` and `task`
 | `orchestra pipeline build`           | Validate local YAML, create or update a draft pipeline, and start that draft version.       |
 | `orchestra task logs`                | Fetch or follow logs for a single task run.                                                 |
 
+Commands that read a local pipeline file (`pipeline validate`, `import`, `new`, `update`, `build`, and `run --path` with `--task`) accept `.yaml`, `.yml` and `.oml` files; any other extension is rejected. `.oml` files are read as YAML, so only OML written in YAML or JSON syntax is supported. OML block terminators (`.`) and embeds (`%sql ... %%`) fail with an `Invalid YAML` error.
+
 Use `orchestra --help`, `orchestra <noun> --help`, or `orchestra <noun> <verb> --help` for built-in help.
 
 ### Legacy command names
@@ -63,7 +65,7 @@ New code and documentation should prefer the noun/verb form.
 
 ## pipeline validate
 
-Validate a YAML file against the Orchestra API schema.
+Validate a pipeline file against the Orchestra API schema.
 
 ```bash
 orchestra pipeline validate path/to/pipeline.yaml
@@ -73,7 +75,7 @@ orchestra-cli pipeline validate path/to/pipeline.yaml
 
 Options
 
-- `file` (positional): Path to the YAML file to validate.
+- `file` (positional): Path to the `.yaml`, `.yml` or `.oml` file to validate.
 
 Behavior
 

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/orchestra_cli/src/validate_pipeline.py

@@ -9,7 +9,7 @@ import yaml
 from ..utils.api import request_or_exit
 from ..utils.constants import get_api_url
 from ..utils.styling import bold, green, indent_message, red, yellow
-from ..utils.yaml_loader import load_yaml
+from ..utils.yaml_loader import echo_invalid_yaml, exit_if_unsupported_extension, load_yaml
 
 
 def get_yaml_snippet(data: Any, loc: list[Any]) -> dict[str, Any] | None:
@@ -39,14 +39,18 @@ def _render_validation_details(details: list[dict[str, Any]], data: Any) -> None
             typer.echo(yellow("(Could not locate this path in your YAML)"))
 
 
-def validate(file: Path = typer.Argument(..., help="YAML file to validate")):
+def validate(
+    file: Path = typer.Argument(..., help="Pipeline file to validate (.yaml, .yml or .oml)"),
+):
     """
-    Validate a YAML file against the API.
+    Validate a pipeline file (.yaml, .yml or .oml) against the API.
     """
     if not file.exists():
         typer.echo(red(f"File not found: {file}"))
         raise typer.Exit(code=1)
 
+    exit_if_unsupported_extension(file)
+
     data, err = load_yaml(file)
     if err is not None:
         try:
@@ -60,7 +64,7 @@ def validate(file: Path = typer.Argument(..., help="YAML file to validate")):
                 _render_validation_details(details, data)
                 raise typer.Exit(code=1)
 
-        typer.echo(red(f"Invalid YAML: {err}"))
+        echo_invalid_yaml(file, err)
         raise typer.Exit(code=1)
 
     response = request_or_exit(httpx.post, get_api_url("pipelines/schema"), json=data, timeout=10)

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/orchestra_cli/tests/test_create_pipeline.py

@@ -249,3 +249,15 @@ def test_create_success_with_invalid_json_fails(tmp_path: Path, httpx_mock: HTTP
     result = runner.invoke(app, ["pipeline", "new", "--alias", "demo", "--path", str(yaml_file)])
     assert result.exit_code == 1
     assert "success response was not valid JSON" in result.output
+
+
+def test_create_rejects_unsupported_extension(tmp_path: Path):
+    pipeline_file = tmp_path / "pipe.json"
+    pipeline_file.write_text('{"name": "demo"}')
+
+    result = runner.invoke(
+        app,
+        ["pipeline", "new", "--alias", "demo", "--path", str(pipeline_file)],
+    )
+    assert result.exit_code == 1
+    assert "Unsupported file extension '.json'" in result.output

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/orchestra_cli/tests/test_validate_pipeline.py

@@ -89,3 +89,44 @@ def test_validate_fails_on_duplicate_yaml_keys(tmp_path):
     assert "YAML snippet:" in result.output
     assert "connection: first" in result.output
     assert "team: data" in result.output
+
+
+def test_validate_oml_file_posts_expected_json(tmp_path, httpx_mock: HTTPXMock):
+    pipeline_file = tmp_path / "pipeline.oml"
+    pipeline_file.write_text('{"version": "v1", "name": "anomalies"}')
+    httpx_mock.add_response(
+        method="POST",
+        url="https://app.getorchestra.io/api/engine/public/pipelines/schema",
+        json={"ok": True},
+        status_code=200,
+    )
+
+    result = runner.invoke(app, ["pipeline", "validate", str(pipeline_file)])
+
+    assert result.exit_code == 0
+    assert "Validation passed" in result.output
+    requests = httpx_mock.get_requests()
+    assert len(requests) == 1
+    assert json.loads(requests[0].content) == {"version": "v1", "name": "anomalies"}
+
+
+def test_validate_oml_only_syntax_explains_limitation(tmp_path):
+    pipeline_file = tmp_path / "pipeline.oml"
+    pipeline_file.write_text("task:\n  sql: %sql select 1 %%\n")
+
+    result = runner.invoke(app, ["pipeline", "validate", str(pipeline_file)])
+
+    assert result.exit_code == 1
+    assert "Invalid YAML" in result.output
+    assert "embeds (`%sql ... %%`), those are not supported yet" in result.output
+
+
+def test_validate_rejects_unsupported_extension(tmp_path):
+    pipeline_file = tmp_path / "pipeline.json"
+    pipeline_file.write_text('{"version": "v1"}')
+
+    result = runner.invoke(app, ["pipeline", "validate", str(pipeline_file)])
+
+    assert result.exit_code == 1
+    assert "Unsupported file extension '.json'" in result.output
+    assert ".yaml, .yml, .oml" in result.output

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/orchestra_cli/utils/yaml_loader.py

@@ -16,6 +16,8 @@ import yaml
 from .constants import get_api_url
 from .styling import indent_message, red, yellow
 
+SUPPORTED_EXTENSIONS = (".yaml", ".yml", ".oml")
+
 
 class DuplicateKeyYAMLError(Exception):
     def __init__(self, details: list[dict[str, Any]], parsed_data: dict[str, Any] | None = None):
@@ -67,6 +69,28 @@ class DuplicateKeySafeLoader(yaml.SafeLoader):
         return mapping
 
 
+def exit_if_unsupported_extension(path: Path) -> None:
+    if path.suffix.lower() not in SUPPORTED_EXTENSIONS:
+        typer.echo(
+            red(
+                f"Unsupported file extension '{path.suffix}': "
+                f"expected one of {', '.join(SUPPORTED_EXTENSIONS)}",
+            ),
+        )
+        raise typer.Exit(code=1)
+
+
+def echo_invalid_yaml(path: Path, err: str) -> None:
+    typer.echo(red(f"Invalid YAML: {err}"))
+    if path.suffix.lower() == ".oml":
+        typer.echo(
+            yellow(
+                ".oml files are read as YAML. If this file uses OML block terminators (`.`) "
+                "or embeds (`%sql ... %%`), those are not supported yet.",
+            ),
+        )
+
+
 def load_yaml(file: Path) -> tuple[dict | None, str | None]:
     """Read a YAML file and return ``(data, None)`` or ``(None, error_message)``."""
     try:
@@ -109,9 +133,11 @@ def load_validated_pipeline_data(path: Path) -> dict:
         typer.echo(red(f"File not found: {path}"))
         raise typer.Exit(code=1)
 
+    exit_if_unsupported_extension(path)
+
     data, err = load_yaml(path)
     if err is not None:
-        typer.echo(red(f"Invalid YAML: {err}"))
+        echo_invalid_yaml(path, err)
         raise typer.Exit(code=1)
 
     ok, err_msg = validate_yaml_with_api(data or {})

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/orchestra_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestra-cli
-Version: 0.3.3
+Version: 0.3.5
 Summary: Orchestra CLI. Perform operations with Orchestra locally.
 Author-email: Orchestra Technologies <support@getorchestra.io>
 Requires-Python: >=3.10
@@ -55,6 +55,8 @@ Commands follow a `noun verb` shape. The current nouns are `pipeline` and `task`
 | `orchestra pipeline build`           | Validate local YAML, create or update a draft pipeline, and start that draft version.       |
 | `orchestra task logs`                | Fetch or follow logs for a single task run.                                                 |
 
+Commands that read a local pipeline file (`pipeline validate`, `import`, `new`, `update`, `build`, and `run --path` with `--task`) accept `.yaml`, `.yml` and `.oml` files; any other extension is rejected. `.oml` files are read as YAML, so only OML written in YAML or JSON syntax is supported. OML block terminators (`.`) and embeds (`%sql ... %%`) fail with an `Invalid YAML` error.
+
 Use `orchestra --help`, `orchestra <noun> --help`, or `orchestra <noun> <verb> --help` for built-in help.
 
 ### Legacy command names
@@ -77,7 +79,7 @@ New code and documentation should prefer the noun/verb form.
 
 ## pipeline validate
 
-Validate a YAML file against the Orchestra API schema.
+Validate a pipeline file against the Orchestra API schema.
 
 ```bash
 orchestra pipeline validate path/to/pipeline.yaml
@@ -87,7 +89,7 @@ orchestra-cli pipeline validate path/to/pipeline.yaml
 
 Options
 
-- `file` (positional): Path to the YAML file to validate.
+- `file` (positional): Path to the `.yaml`, `.yml` or `.oml` file to validate.
 
 Behavior
 

{orchestra_cli-0.3.3 → orchestra_cli-0.3.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "orchestra-cli"
-version = "0.3.3"
+version = "0.3.5"
 description = "Orchestra CLI. Perform operations with Orchestra locally."
 readme = "README.md"
 authors = [
@@ -48,6 +48,11 @@ line-length = 100
 # N = pep8-naming
 select = ["E", "F", "W", "I", "N", "UP", "ARG", "COM"]
 
+[tool.ruff.lint.isort]
+# `requires-python = ">=3.10"` makes ruff classify tomllib as third-party, but
+# the dev scripts that import it run on 3.12.
+extra-standard-library = ["tomllib"]
+
 [tool.black]
 line-length = 100
 exclude = '''